diff --git a/docs/nirfsg/class.rst b/docs/nirfsg/class.rst index c35091f21..9d0012789 100644 --- a/docs/nirfsg/class.rst +++ b/docs/nirfsg/class.rst @@ -3,13 +3,13 @@ Session ======= -.. py:class:: Session(self, resource_name, id_query, reset_device, options={}) +.. py:class:: Session(self, resource_name, options={}, id_query=False, reset_device=False) - Opens a session to the device you specify as the **:py:attr:`nirfsg.Session.RESOURCE_NAME`** and returns a ViSession handle that you use to identify the NI-RFSG device in all subsequent NI-RFSG method calls. + Opens a session to the device you specify as the :py:attr:`nirfsg.Session.RESOURCE_NAME` and returns a ViSession handle that you use to identify the NI-RFSG device in all subsequent NI-RFSG method calls. - This method also configures the device through the **:py:attr:`nirfsg.Session.OPTION_STRING`** input. + This method also configures the device through the :py:attr:`nirfsg.Session.OPTION_STRING` input. **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -41,6 +41,40 @@ Session :type resource_name: str + :param options: + + + Specifies the initial value of certain properties for the session. The + syntax for **options** is a dictionary of properties with an assigned + value. For example: + + { 'simulate': False } + + You do not have to specify a value for all the properties. If you do not + specify a value for a property, the default value is used. + + Advanced Example: + { 'simulate': True, 'driver_setup': { 'Model': '', 'BoardType': '' } } + + +-------------------------+---------+ + | Property | Default | + +=========================+=========+ + | range_check | True | + +-------------------------+---------+ + | query_instrument_status | False | + +-------------------------+---------+ + | cache | True | + +-------------------------+---------+ + | simulate | False | + +-------------------------+---------+ + | record_value_coersions | False | + +-------------------------+---------+ + | driver_setup | {} | + +-------------------------+---------+ + + + :type options: str + :param id_query: @@ -77,40 +111,6 @@ Session :type reset_device: bool - :param options: - - - Specifies the initial value of certain properties for the session. The - syntax for **options** is a dictionary of properties with an assigned - value. For example: - - { 'simulate': False } - - You do not have to specify a value for all the properties. If you do not - specify a value for a property, the default value is used. - - Advanced Example: - { 'simulate': True, 'driver_setup': { 'Model': '', 'BoardType': '' } } - - +-------------------------+---------+ - | Property | Default | - +=========================+=========+ - | range_check | True | - +-------------------------+---------+ - | query_instrument_status | False | - +-------------------------+---------+ - | cache | True | - +-------------------------+---------+ - | simulate | False | - +-------------------------+---------+ - | record_value_coersions | False | - +-------------------------+---------+ - | driver_setup | {} | - +-------------------------+---------+ - - - :type options: str - Methods ======= @@ -511,7 +511,7 @@ check_if_script_exists .. py:method:: check_if_script_exists(script_name) - Returns whether the script that you specify as **:py:attr:`nirfsg.Session.SCRIPT_NAME`** exists. + Returns whether the script that you specify as :py:attr:`nirfsg.Session.SCRIPT_NAME` exists. **Supported Devices** : PXIe-5673/5673E. PXIe-5830/5831/5840/5841/5842/5860 @@ -556,7 +556,7 @@ check_if_waveform_exists .. py:method:: check_if_waveform_exists(waveform_name) - Returns whether the waveform that you specify as **:py:attr:`nirfsg.Session.WAVEFORM_NAME`** exists. + Returns whether the waveform that you specify as :py:attr:`nirfsg.Session.WAVEFORM_NAME` exists. **Supported Devices** : PXIe-5673/5673E, PXIe-5830/5831/5840/5841/5842/5860 @@ -1087,7 +1087,7 @@ configure_output_enabled Enables or disables signal output. - Setting **:py:attr:`nirfsg.Session.output_enabled`** to False while in the Generation state attenuates the generated signal so that no signal is output. + Setting :py:attr:`nirfsg.Session.output_enabled` to False while in the Generation state attenuates the generated signal so that no signal is output. **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -1122,7 +1122,7 @@ configure_p2_p_endpoint_fullness_start_trigger Configures the Start Trigger to detect peer-to-peer endpoint fullness. - Generation begins when the number of samples in the peer-to-peer endpoint reaches the threshold specified by the **:py:attr:`nirfsg.Session.P2P_ENDPOINT_FULLNESS_LEVEL`** parameter. The NI-RFSG device must be in the Configuration state before calling this method. + Generation begins when the number of samples in the peer-to-peer endpoint reaches the threshold specified by the :py:attr:`nirfsg.Session.P2P_ENDPOINT_FULLNESS_LEVEL` parameter. The NI-RFSG device must be in the Configuration state before calling this method. **Supported Devices** : PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 @@ -1261,13 +1261,13 @@ configure_ref_clock +-----------------------------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:data:`~nirfsg.NIRFSG_VAL_REF_IN_STR` | RefIn | Uses the clock signal present at the front panel REF IN connector as the clock source. **PXIe-5830/5831/5832** :For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. For the PXIe-5832, connect the PXIe-5820 REF IN connector to the PXIe-3623 REF OUT connector. For the PXIe-5830, lock the external signal to the PXIe-3621 REF IN connector. For the PXIe-5831, lock the external signal to the PXIe-3622 REF IN connector. For the PXIe-5832, lock the external signal to the PXIe-3623 REF IN connector. **PXIe-5831 with PXIe-5653** :Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector. Lock the external signal to the PXIe-5653 REF IN connector. **PXIe-5832 with PXIe-5653** :Connect the PXIe-5820 REF IN connector to the PXIe-3623 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3623 REF IN connector. Lock the external signal to the PXIe-5653 REF IN connector. **PXIe-5841 with PXIe-5655** :Lock to the signal at the REF IN connector on the associated PXIe-5655. Connect the PXIe-5655 REF OUT connector to the PXIe-5841 REF IN connector. **PXIe-5842** :Lock to the signal at the REF IN connector on the associated PXIe-5655. Cables between modules are required as shown in the Getting Started Guide for the instrument. | +-----------------------------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ReferenceClockSource.PXI_CLK` | PXI_CLK | Uses the PXI_CLK signal, which is present on the PXI backplane, as the clock source. | + | :py:data:`~nirfsg.NIRFSG_VAL_PXI_CLK_STR` | PXI_CLK | Uses the PXI_CLK signal, which is present on the PXI backplane, as the clock source. | +-----------------------------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:data:`~nirfsg.NIRFSG_VAL_CLK_IN_STR` | ClkIn | Uses the clock signal present at the front panel CLK IN connector as the clock source. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5831 with PXIe-5653/5832/5832 with PXIe-5653/5840/5841/5841 with PXIe-5655/5842. | +-----------------------------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ReferenceClockSource.REF_IN_2` | RefIn2 | - | + | :py:data:`~nirfsg.NIRFSG_VAL_REF_IN_2_STR` | RefIn2 | \- | +-----------------------------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ReferenceClockSource.PXI_CLK_MASTER` | PXI_ClkMaster | This value is valid on only the PXIe-5831 with PXIe-5653 and PXIe-5832 with PXIe-5653. **PXIe-5831 with PXIe-5653** :NI-RFSG configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3622 to use PXI_Clk as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector. **PXIe-5832 with PXIe-5653** :NI-RFSG configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3623 to use PXI_Clk as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector. | + | :py:data:`~nirfsg.NIRFSG_VAL_PXI_CLK_MASTER_STR` | PXI_ClkMaster | This value is valid on only the PXIe-5831 with PXIe-5653 and PXIe-5832 with PXIe-5653. **PXIe-5831 with PXIe-5653** :NI-RFSG configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3622 to use PXI_Clk as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector. **PXIe-5832 with PXIe-5653** :NI-RFSG configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3623 to use PXI_Clk as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector. | +-----------------------------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. @@ -1277,7 +1277,7 @@ configure_ref_clock :param ref_clock_rate: - Specifies the Reference Clock rate, in hertz (Hz), of the signal present at the REF IN or CLK IN connector. The default value is :py:data:`~nirfsg.NIRFSG_VAL_AUTO`, which allows NI-RFSG to use the default Reference Clock rate for the device or automatically detect the Reference Clock rate, if supported. This parameter is only valid when the **:py:attr:`nirfsg.Session.ref_clock_source`** parameter is set to :py:data:`~nirfsg.NIRFSG_VAL_CLK_IN_STR`, :py:data:`~nirfsg.NIRFSG_VAL_REF_IN_STR` or :py:data:`~nirfsg.ReferenceClockSource.REF_IN_2`. Refer to the :py:attr:`nirfsg.Session.ref_clock_rate` property for possible values. + Specifies the Reference Clock rate, in hertz (Hz), of the signal present at the REF IN or CLK IN connector. The default value is :py:data:`~nirfsg.NIRFSG_VAL_AUTO`, which allows NI-RFSG to use the default Reference Clock rate for the device or automatically detect the Reference Clock rate, if supported. This parameter is only valid when the :py:attr:`nirfsg.Session.ref_clock_source` parameter is set to :py:data:`~nirfsg.NIRFSG_VAL_CLK_IN_STR`, :py:data:`~nirfsg.NIRFSG_VAL_REF_IN_STR` or :py:data:`~nirfsg.NIRFSG_VAL_REF_IN_2_STR`. Refer to the :py:attr:`nirfsg.Session.ref_clock_rate` property for possible values. @@ -1662,55 +1662,168 @@ export_signal :param signal_identifier: - Specifies which instance of the selected signal to export. This parameter is useful when you set the :py:attr:`nirfsg.Session.SIGNAL` parameter to :py:data:`~nirfsg.NIRFSG_VAL_SCRIPT_TRIGGER` or :py:data:`~nirfsg.NIRFSG_VAL_MARKER_EVENT`. Otherwise, set the :py:attr:`nirfsg.Session.SIGNAL_IDENTIFIER` parameter to '' (empty string). **Defined Values** : - - +-----------------------------------------------------+----------------+-----------------------------+ - | Name | Value | Description | - +=====================================================+================+=============================+ - | :py:data:`~nirfsg.SignalIdentifier.MARKER_EVENT0` | marker0 | Specifies Marker 0. | - +-----------------------------------------------------+----------------+-----------------------------+ - | :py:data:`~nirfsg.SignalIdentifier.MARKER_EVENT1` | marker1 | Specifies Marker 1. | - +-----------------------------------------------------+----------------+-----------------------------+ - | :py:data:`~nirfsg.SignalIdentifier.MARKER_EVENT2` | marker2 | Specifies Marker 2. | - +-----------------------------------------------------+----------------+-----------------------------+ - | :py:data:`~nirfsg.SignalIdentifier.MARKER_EVENT3` | marker3 | Specifies Marker 3. | - +-----------------------------------------------------+----------------+-----------------------------+ - | :py:data:`~nirfsg.SignalIdentifier.SCRIPT_TRIGGER0` | scriptTrigger0 | Specifies Script Trigger 0. | - +-----------------------------------------------------+----------------+-----------------------------+ - | :py:data:`~nirfsg.SignalIdentifier.SCRIPT_TRIGGER1` | scriptTrigger1 | Specifies Script Trigger 1. | - +-----------------------------------------------------+----------------+-----------------------------+ - | :py:data:`~nirfsg.SignalIdentifier.SCRIPT_TRIGGER2` | scriptTrigger2 | Specifies Script Trigger 2. | - +-----------------------------------------------------+----------------+-----------------------------+ - | :py:data:`~nirfsg.SignalIdentifier.SCRIPT_TRIGGER3` | scriptTrigger3 | Specifies Script Trigger 3. | - +-----------------------------------------------------+----------------+-----------------------------+ + Specifies which instance of the selected signal to export. This parameter is useful when you set the :py:attr:`nirfsg.Session.SIGNAL` parameter to :py:data:`~nirfsg.NIRFSG_VAL_SCRIPT_TRIGGER` or :py:data:`~nirfsg.NIRFSG_VAL_MARKER_EVENT`. Otherwise, set the :py:attr:`nirfsg.Session.SIGNAL_IDENTIFIER` parameter to '' (empty string). **Possible Values** : + + +----------------+-----------------------------+ + | Possible Value | Description | + +================+=============================+ + | marker0 | Specifies Marker 0. | + +----------------+-----------------------------+ + | marker1 | Specifies Marker 1. | + +----------------+-----------------------------+ + | marker2 | Specifies Marker 2. | + +----------------+-----------------------------+ + | marker3 | Specifies Marker 3. | + +----------------+-----------------------------+ + | scriptTrigger0 | Specifies Script Trigger 0. | + +----------------+-----------------------------+ + | scriptTrigger1 | Specifies Script Trigger 1. | + +----------------+-----------------------------+ + | scriptTrigger2 | Specifies Script Trigger 2. | + +----------------+-----------------------------+ + | scriptTrigger3 | Specifies Script Trigger 3. | + +----------------+-----------------------------+ .. note:: One or more of the referenced properties are not in the Python API for this driver. .. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. - :type signal_identifier: :py:data:`nirfsg.SignalIdentifier` + :type signal_identifier: str :param output_terminal: - Specifies the terminal where the signal is exported. You can choose not to export any signal. For the PXIe-5841 with PXIe-5655, the signal is exported to the terminal on the PXIe-5841. **Defined Values** : + Specifies the terminal where the signal is exported. You can choose not to export any signal. For the PXIe-5841 with PXIe-5655, the signal is exported to the terminal on the PXIe-5841. **Possible Values** : - +---------------------------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | | - +=====================================================================+=========+============================================================================================+=======================================================================================================================================================================+ - | :py:data:`~nirfsg.ReferenceClockExportOutputTerminal.CLK_OUT` | ClkOut | Exports the Reference Clock signal to the CLK OUT connector of the device. | Supported on PXIe-5673, 5673E | - +---------------------------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ReferenceClockExportOutputTerminal.DO_NOT_EXPORT` | | The Reference Clock signal is not exported. | Supported on PXIe-5644/5645/5646, 5820/5830/5831/5832/5840/5841/5842/5860, 5650/5651/5652, 5654, 5673, 5673E, PXIe-5654 with PXIe-5696, PXI-5650/5651/5652 (See Note) | - +---------------------------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ReferenceClockExportOutputTerminal.REF_OUT` | RefOut | Exports the Reference Clock signal to the REF OUT connector of the device. | Supported on PXIe-5644/5645/5646, 5820/5830/5831/5832/5840/5841/5842/5860, 5650/5651/5653, 5653, 5654, 5673, 5673E, PXIe-5654 with PXIe-5696, PXI-5650/5651/5653, | - +---------------------------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ReferenceClockExportOutputTerminal.REF_OUT2` | RefOut2 | Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable. | Supported on PXIe-5650/5651/5652, 5654, 5673E, PXIe-5654 with PXIe-5696 | - +---------------------------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------+--------------------------------------------------------------------------------------------+ + | Possible Value | Description | + +================+============================================================================================+ + | ClkOut | Exports the Reference Clock signal to the CLK OUT connector of the device. | + +----------------+--------------------------------------------------------------------------------------------+ + | | The Reference Clock signal is not exported. | + +----------------+--------------------------------------------------------------------------------------------+ + | RefOut | Exports the Reference Clock signal to the REF OUT connector of the device. | + +----------------+--------------------------------------------------------------------------------------------+ + | RefOut2 | Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable. | + +----------------+--------------------------------------------------------------------------------------------+ - .. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. + + :type output_terminal: str + +get_all_named_waveform_names +---------------------------- + + .. py:currentmodule:: nirfsg.Session + + .. py:method:: get_all_named_waveform_names() + + Return names of the waveforms present in the memory. + + **Supported Devices** :PXIe-5830/5831/5840/5841/5842E + + + + + + :rtype: tuple (waveform_names, actual_buffer_size) + + WHERE + + waveform_names (str): + + + Returns a string having waveform names separated by commas. + + + + + actual_buffer_size (int): + + + Fetch the number of bytes needed to pass in the :py:attr:`nirfsg.Session.BUFFER_SIZE` parameter. + + It can be fetch by passing VI_NULL in the :py:attr:`nirfsg.Session.WAVEFORM_NAMES` parameter. + + + + .. note:: One or more of the referenced properties are not in the Python API for this driver. + + + +get_all_script_names +-------------------- + + .. py:currentmodule:: nirfsg.Session + + .. py:method:: get_all_script_names() + + Return names of the scripts present in the memory. + + **Supported Devices** :PXIe-5830/5831/5840/5841/5842E + + + + + + :rtype: tuple (script_names, actual_buffer_size) + + WHERE + + script_names (str): + + + Returns a string having script names separated by commas. + + + + + actual_buffer_size (int): + + + Fetch the number of bytes needed to pass in the :py:attr:`nirfsg.Session.BUFFER_SIZE` parameter. + + It can be fetch by passing VI_NULL in the :py:attr:`nirfsg.Session.SCRIPT_NAMES` parameter. + + + + .. note:: One or more of the referenced properties are not in the Python API for this driver. + + + +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. + + - :type output_terminal: :py:data:`nirfsg.ReferenceClockExportOutputTerminal` get_error --------- @@ -1909,6 +2022,102 @@ get_stream_endpoint_handle +get_terminal_name +----------------- + + .. py:currentmodule:: nirfsg.Session + + .. py:method:: get_terminal_name(signal, signal_identifier) + + Returns the fully-qualified name of the specified signal. + + The fully-qualified name is helpful to automatically route signals in a multisegment chassis. + + **Supported Devices** : PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + + **Related Topics** + + `Triggers `_ + + `Events `_ + + `Syntax for Terminal Names `_ + + + + + + :param signal: + + + Specifies the signal to query. **Defined Values** : + + +-----------------------------------------------------------+---------+--------------------------------------------+ + | Name | Value | Description | + +===========================================================+=========+============================================+ + | :py:data:`~nirfsg.Signal.START_TRIGGER` | 0 (0x0) | Exports a Start Trigger. | + +-----------------------------------------------------------+---------+--------------------------------------------+ + | :py:data:`~nirfsg.Signal.SCRIPT_TRIGGER` | 1 (0x1) | Exports a Script Trigger. | + +-----------------------------------------------------------+---------+--------------------------------------------+ + | :py:data:`~nirfsg.Signal.MARKER_EVENT` | 2 (0x2) | Exports a Marker Event. | + +-----------------------------------------------------------+---------+--------------------------------------------+ + | :py:data:`~nirfsg.Signal.REF_CLOCK` | 3 (0x3) | Exports the Reference Clock. | + +-----------------------------------------------------------+---------+--------------------------------------------+ + | :py:data:`~nirfsg.Signal.STARTED_EVENT` | 4 (0x4) | Exports a Started Event. | + +-----------------------------------------------------------+---------+--------------------------------------------+ + | :py:data:`~nirfsg.Signal.DONE_EVENT` | 5 (0x5) | Exports a Done Event. | + +-----------------------------------------------------------+---------+--------------------------------------------+ + | :py:data:`~nirfsg.Signal.CONFIGURATION_LIST_STEP_TRIGGER` | 6 (0x6) | Exports a Configuration List Step Trigger. | + +-----------------------------------------------------------+---------+--------------------------------------------+ + | :py:data:`~nirfsg.Signal.CONFIGURATION_SETTLED_EVENT` | 7 (0x7) | Exports a Configuration Settled Event. | + +-----------------------------------------------------------+---------+--------------------------------------------+ + + .. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. + + + :type signal: :py:data:`nirfsg.Signal` + :param signal_identifier: + + + Specifies which instance of the selected signal to query. This parameter is necessary when you set the :py:attr:`nirfsg.Session.SIGNAL` parameter to :py:data:`~nirfsg.NIRFSG_VAL_SCRIPT_TRIGGER` or :py:data:`~nirfsg.NIRFSG_VAL_MARKER_EVENT` . Otherwise, set the :py:attr:`nirfsg.Session.SIGNAL_IDENTIFIER` parameter to '' (empty string). **Possible Values** : + + +----------------+-----------------------------+ + | Possible Value | Description | + +================+=============================+ + | marker0 | Specifies Marker 0. | + +----------------+-----------------------------+ + | marker1 | Specifies Marker 1. | + +----------------+-----------------------------+ + | marker2 | Specifies Marker 2. | + +----------------+-----------------------------+ + | marker3 | Specifies Marker 3. | + +----------------+-----------------------------+ + | scriptTrigger0 | Specifies Script Trigger 0. | + +----------------+-----------------------------+ + | scriptTrigger1 | Specifies Script Trigger 1. | + +----------------+-----------------------------+ + | scriptTrigger2 | Specifies Script Trigger 2. | + +----------------+-----------------------------+ + | scriptTrigger3 | Specifies Script Trigger 3. | + +----------------+-----------------------------+ + + .. note:: One or more of the referenced properties are not in the Python API for this driver. + + .. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. + + + :type signal_identifier: str + + :rtype: str + :return: + + + Returns the string to use as the source for other devices. + + + + + initiate -------- @@ -2194,7 +2403,7 @@ reset Generally, calling this method instead of the :py:meth:`nirfsg.Session.reset_device` method is acceptable. The :py:meth:`nirfsg.Session.reset` method executes faster than the :py:meth:`nirfsg.Session.reset_device` method. - To avoid resetting routes on the PXIe-5644/5645/5646 and PXIe-5820/5830/5831/5832/5840/5841/5842/5860 that are in use by NI-RFSA sessions, NI recommends using the :py:meth:`nirfsg.Session.ResetWithOptions` method, with **stepsToOmit** set to :py:data:`~nirfsg.ResetWithOptionsStepsToOmit.ROUTES` . + To avoid resetting routes on the PXIe-5644/5645/5646 and PXIe-5820/5830/5831/5832/5840/5841/5842/5860 that are in use by NI-RFSA sessions, NI recommends using the :py:meth:`nirfsg.Session.reset_with_options` method, with **stepsToOmit** set to :py:data:`~nirfsg.ResetWithOptionsStepsToOmit.ROUTES` . **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -2286,6 +2495,59 @@ reset_with_defaults +reset_with_options +------------------ + + .. py:currentmodule:: nirfsg.Session + + .. py:method:: reset_with_options(steps_to_omit) + + Resets all properties to default values and specifies steps to omit during the reset process, such as signal routes. + + By default, this method exhibits the same behavior as :py:meth:`nirfsg.Session.reset`. You can specify steps to omit using the steps to omit parameter. For example, if you specify :py:data:`~nirfsg.ResetWithOptionsStepsToOmit.ROUTES` for the :py:attr:`nirfsg.Session.STEPS_TO_OMIT` parameter, this method does not release signal routes during the reset process. + + When routes of signals between two devices are released, they are released regardless of which device created the route. + + To avoid resetting routes on PXIe-5820/5830/5831/5832/5840/5841/5842/5860 that are in use by NI-RFSA sessions, NI recommends using this method instead of :py:meth:`nirfsg.Session.reset`, with :py:attr:`nirfsg.Session.STEPS_TO_OMIT` set to :py:data:`~nirfsg.ResetWithOptionsStepsToOmit.ROUTES`. + + **Supported Devices** : PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + + **Related Topics** + + `Triggers `_ + + `Events `_ + + + + .. note:: One or more of the referenced properties are not in the Python API for this driver. + + + + :param steps_to_omit: + + + Specifies a list of steps to skip during the reset process. The default value is :py:data:`~nirfsg.ResetWithOptionsStepsToOmit.NONE`, which specifies that no step is omitted during reset. **Defined Values** : + + +-------------------------------------------------------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Value | Description | + +===================================================================+=========+============================================================================================================================================================================================================+ + | :py:data:`~nirfsg.ResetWithOptionsStepsToOmit.NONE` | 0 (0x0) | No step is omitted during reset. | + +-------------------------------------------------------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :py:data:`~nirfsg.ResetWithOptionsStepsToOmit.WAVEFORMS` | 1 (0x1) | Omits clearing waveforms. | + +-------------------------------------------------------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :py:data:`~nirfsg.ResetWithOptionsStepsToOmit.SCRIPTS` | 2 (0x2) | Omits clearing scripts. | + +-------------------------------------------------------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :py:data:`~nirfsg.ResetWithOptionsStepsToOmit.ROUTES` | 4 (0x4) | Omits the routing reset step. Routing is preserved after a reset. However, routing related properties are reset to default, and routing is released if the default properties are committed after a reset. | + +-------------------------------------------------------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :py:data:`~nirfsg.ResetWithOptionsStepsToOmit.DEEMBEDDING_TABLES` | 8 (0x8) | Omits deleting de-embedding tables. This step is valid only for the PXIe-5830/5831/5832/5840. | + +-------------------------------------------------------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. note:: :py:data:`~nirfsg.ResetWithOptionsStepsToOmit.ROUTES` is not supported in external calibration or alignment sessions. + + + :type steps_to_omit: :py:data:`nirfsg.ResetWithOptionsStepsToOmit` + save_configurations_to_file --------------------------- @@ -2564,32 +2826,32 @@ send_software_edge_trigger :param trigger_identifier: - Specifies the Script Trigger to configure. This parameter is valid only when you set the :py:attr:`nirfsg.Session.TRIGGER` parameter to :py:data:`~nirfsg.NIRFSG_VAL_START_TRIGGER`. Otherwise, set the **:py:attr:`nirfsg.Session.TRIGGER_IDENTIFIER`** parameter to "" (empty string). + Specifies the Script Trigger to configure. This parameter is valid only when you set the :py:attr:`nirfsg.Session.TRIGGER` parameter to :py:data:`~nirfsg.NIRFSG_VAL_START_TRIGGER`. Otherwise, set the :py:attr:`nirfsg.Session.TRIGGER_IDENTIFIER` parameter to "" (empty string). **Default Value:** "" (empty string) - **Defined Values:** - - +--------------------------------------------------------+----------------+-----------------------------+ - | Name | Value | Description | - +========================================================+================+=============================+ - | :py:data:`~nirfsg.TriggerIdentifier.SCRIPT_TRIGGER0` | scriptTrigger0 | Specifies Script Trigger 0. | - +--------------------------------------------------------+----------------+-----------------------------+ - | :py:data:`~nirfsg.TriggerIdentifier.SCRIPT_TRIGGER1` | scriptTrigger1 | Specifies Script Trigger 1. | - +--------------------------------------------------------+----------------+-----------------------------+ - | :py:data:`~nirfsg.TriggerIdentifier.SCRIPT_TRIGGER2` | scriptTrigger2 | Specifies Script Trigger 2. | - +--------------------------------------------------------+----------------+-----------------------------+ - | :py:data:`~nirfsg.TriggerIdentifier.SCRIPT_TRIGGER3` | scriptTrigger3 | Specifies Script Trigger 3. | - +--------------------------------------------------------+----------------+-----------------------------+ - | :py:data:`~nirfsg.TriggerIdentifier.NONE_EMPTY_STRING` | | None (no signal to export) | - +--------------------------------------------------------+----------------+-----------------------------+ + **Possible Values:** + + +----------------+-----------------------------+ + | Possible Value | Description | + +================+=============================+ + | scriptTrigger0 | Specifies Script Trigger 0. | + +----------------+-----------------------------+ + | scriptTrigger1 | Specifies Script Trigger 1. | + +----------------+-----------------------------+ + | scriptTrigger2 | Specifies Script Trigger 2. | + +----------------+-----------------------------+ + | scriptTrigger3 | Specifies Script Trigger 3. | + +----------------+-----------------------------+ + | | None (no signal to export) | + +----------------+-----------------------------+ .. note:: One or more of the referenced properties are not in the Python API for this driver. .. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. - :type trigger_identifier: :py:data:`nirfsg.TriggerIdentifier` + :type trigger_identifier: str set_arb_waveform_next_write_position ------------------------------------ @@ -3887,9 +4149,9 @@ arb_sample_clock_source Specifies the Sample Clock source for the device. To set this property, the NI-RFSG device must be in the Configuration state. - PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: :py:data:`~nirfsg.ArbSampleClockSource.ONBOARD_CLOCK` is the only supported value for this device. + PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: :py:data:`~nirfsg.NIRFSG_VAL_ONBOARD_CLOCK_STR` is the only supported value for this device. - **Default Value:** :py:data:`~nirfsg.ArbSampleClockSource.ONBOARD_CLOCK` + **Default Value:** :py:data:`~nirfsg.NIRFSG_VAL_ONBOARD_CLOCK_STR` **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -3897,29 +4159,29 @@ arb_sample_clock_source `Timing Configurations `_ - **Defined Values**: + **Possible Values**: - +-------------------------------------------------------+--------------+---------------------------------------------------------------+ - | Name | Value | Description | - +=======================================================+==============+===============================================================+ - | :py:data:`~nirfsg.ArbSampleClockSource.CLK_IN` | ClkIn | Uses the external clock as the Sample Clock source. | - +-------------------------------------------------------+--------------+---------------------------------------------------------------+ - | :py:data:`~nirfsg.ArbSampleClockSource.ONBOARD_CLOCK` | OnboardClock | Uses the AWG module onboard clock as the Sample Clock source. | - +-------------------------------------------------------+--------------+---------------------------------------------------------------+ + +----------------+---------------------------------------------------------------+ + | Possible Value | Description | + +================+===============================================================+ + | ClkIn | Uses the external clock as the Sample Clock source. | + +----------------+---------------------------------------------------------------+ + | OnboardClock | Uses the AWG module onboard clock as the Sample Clock source. | + +----------------+---------------------------------------------------------------+ .. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. The following table lists the characteristics of this property. - +-----------------------+----------------------------+ - | Characteristic | Value | - +=======================+============================+ - | Datatype | enums.ArbSampleClockSource | - +-----------------------+----------------------------+ - | Permissions | read-write | - +-----------------------+----------------------------+ - | Repeated Capabilities | None | - +-----------------------+----------------------------+ + +-----------------------+------------+ + | Characteristic | Value | + +=======================+============+ + | Datatype | str | + +-----------------------+------------+ + | Permissions | read-write | + +-----------------------+------------+ + | Repeated Capabilities | None | + +-----------------------+------------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: @@ -4887,27 +5149,27 @@ deembedding_type To use this property, you must use the channelName parameter of the :py:meth:`nirfsg.Session._set_attribute_vi_int32` method to specify the name of the port to configure for de-embedding. - If you set this property to :py:data:`~nirfsg.DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_SCALAR` or :py:data:`~nirfsg.DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_VECTOR`, NI-RFSG adjusts the instrument settings and the returned data to remove the effects of the external network between the instrument and the DUT. + If you set this property to :py:data:`~nirfsg.DeembeddingTypeAttrVals.SCALAR` or :py:data:`~nirfsg.DeembeddingTypeAttrVals.VECTOR`, NI-RFSG adjusts the instrument settings and the returned data to remove the effects of the external network between the instrument and the DUT. - **Default Value**: :py:data:`~nirfsg.DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_SCALAR` + **Default Value**: :py:data:`~nirfsg.DeembeddingTypeAttrVals.SCALAR` - **Valid Values for PXIe-5830/5832/5840/5841/5842/5860** : :py:data:`~nirfsg.DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_SCALAR` or :py:data:`~nirfsg.DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_NONE` + **Valid Values for PXIe-5830/5832/5840/5841/5842/5860** : :py:data:`~nirfsg.DeembeddingTypeAttrVals.SCALAR` or :py:data:`~nirfsg.DeembeddingTypeAttrVals.NONE` - **Valid Values for PXIe-5831** :py:data:`~nirfsg.DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_SCALAR`, :py:data:`~nirfsg.DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_VECTOR`, or :py:data:`~nirfsg.DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_NONE`. :py:data:`~nirfsg.DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_VECTOR` is only supported for TRX Ports in a Semiconductor Test System (STS). + **Valid Values for PXIe-5831** :py:data:`~nirfsg.DeembeddingTypeAttrVals.SCALAR`, :py:data:`~nirfsg.DeembeddingTypeAttrVals.VECTOR`, or :py:data:`~nirfsg.DeembeddingTypeAttrVals.NONE`. :py:data:`~nirfsg.DeembeddingTypeAttrVals.VECTOR` is only supported for TRX Ports in a Semiconductor Test System (STS). **Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860 **Defined Values**: - +--------------------------------------------------------------------+----------------+------------------------------------------------------------------------+ - | Name | Value | Description | - +====================================================================+================+========================================================================+ - | :py:data:`~nirfsg.DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_NONE` | 25000 (0x61a8) | De-embedding is not applied to the measurement. | - +--------------------------------------------------------------------+----------------+------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_SCALAR` | 25001 (0x61a9) | De-embeds the measurement using only the gain term. | - +--------------------------------------------------------------------+----------------+------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_VECTOR` | 25002 (0x61aa) | De-embeds the measurement using the gain term and the reflection term. | - +--------------------------------------------------------------------+----------------+------------------------------------------------------------------------+ + +---------------------------------------------------+----------------+------------------------------------------------------------------------+ + | Name | Value | Description | + +===================================================+================+========================================================================+ + | :py:data:`~nirfsg.DeembeddingTypeAttrVals.NONE` | 25000 (0x61a8) | De-embedding is not applied to the measurement. | + +---------------------------------------------------+----------------+------------------------------------------------------------------------+ + | :py:data:`~nirfsg.DeembeddingTypeAttrVals.SCALAR` | 25001 (0x61a9) | De-embeds the measurement using only the gain term. | + +---------------------------------------------------+----------------+------------------------------------------------------------------------+ + | :py:data:`~nirfsg.DeembeddingTypeAttrVals.VECTOR` | 25002 (0x61aa) | De-embeds the measurement using the gain term and the reflection term. | + +---------------------------------------------------+----------------+------------------------------------------------------------------------+ .. tip:: This property can be set/get on specific deembedding_port within your :py:class:`nirfsg.Session` instance. @@ -5121,61 +5383,59 @@ digital_edge_script_trigger_source - :py:meth:`nirfsg.Session.configure_digital_edge_script_trigger` - **Defined Values**: - - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +================================================================+=============+=========================================================================================================================================+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.PFI0` | PFI0 | The trigger is received on PFI 0. | - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.PFI1` | PFI1 | The trigger is received on PFI 1. | - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.PFI2` | PFI2 | The trigger is received on PFI 2. | - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.PFI3` | PFI3 | The trigger is received on PFI 3. | - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.PXI_STAR` | PXI_Star | The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646. | - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.PXI_TRIG0` | PXI_Trig0 | The trigger is received on PXI trigger line 0. | - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.PXI_TRIG1` | PXI_Trig1 | The trigger is received on PXI trigger line 1. | - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.PXI_TRIG2` | PXI_Trig2 | The trigger is received on PXI trigger line 2. | - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.PXI_TRIG3` | PXI_Trig3 | The trigger is received on PXI trigger line 3. | - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.PXI_TRIG4` | PXI_Trig4 | The trigger is received on PXI trigger line 4. | - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.PXI_TRIG5` | PXI_Trig5 | The trigger is received on PXI trigger line 5. | - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.PXI_TRIG6` | PXI_Trig6 | The trigger is received on PXI trigger line 6. | - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.PXI_TRIG7` | PXI_Trig7 | The trigger is received on PXI trigger line 7. | - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.PXIE_DSTARB` | PXIe_DStarB | The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. | - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.PULSE_IN` | PulseIn | The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842. | - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.DIO0` | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.DIO1` | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.DIO2` | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.DIO3` | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.DIO4` | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.DIO5` | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.DIO6` | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.DIO7` | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.SYNC_SCRIPT_TRIGGER` | Sync_Script | The trigger is received on the Sync Script trigger line. This value is valid on only the PXIe-5644/5645/5646. | - +----------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - - .. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. + **Possible Values**: + + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | Possible Value | Description | + +================+=========================================================================================================================================+ + | PFI0 | The trigger is received on PFI 0. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI1 | The trigger is received on PFI 1. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI2 | The trigger is received on PFI 2. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI3 | The trigger is received on PFI 3. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Star | The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig7 | The trigger is received on PXI trigger line 7. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXIe_DStarB | The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PulseIn | The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | Sync_Script | The trigger is received on the Sync Script trigger line. This value is valid on only the PXIe-5644/5645/5646. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ .. tip:: This property can be set/get on specific script_triggers within your :py:class:`nirfsg.Session` instance. @@ -5189,15 +5449,15 @@ digital_edge_script_trigger_source The following table lists the characteristics of this property. - +-----------------------+-------------------------------+ - | Characteristic | Value | - +=======================+===============================+ - | Datatype | enums.ScriptTrigDigEdgeSource | - +-----------------------+-------------------------------+ - | Permissions | read-write | - +-----------------------+-------------------------------+ - | Repeated Capabilities | script_triggers | - +-----------------------+-------------------------------+ + +-----------------------+-----------------+ + | Characteristic | Value | + +=======================+=================+ + | Datatype | str | + +-----------------------+-----------------+ + | Permissions | read-write | + +-----------------------+-----------------+ + | Repeated Capabilities | script_triggers | + +-----------------------+-----------------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: @@ -5281,73 +5541,71 @@ digital_edge_start_trigger_source - :py:meth:`nirfsg.Session.configure_digital_edge_start_trigger` - **Defined Values**: - - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +================================================================+=============+========================================================================================================================================+ - | :py:data:`~nirfsg.StartTrigDigEdgeSource.PFI0` | PFI0 | The trigger is received on PFI 0. | - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigDigEdgeSource.PFI1` | PFI1 | The trigger is received on PFI 1. | - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigDigEdgeSource.PFI2` | PFI2 | The trigger is received on PFI 2. | - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigDigEdgeSource.PFI3` | PFI3 | The trigger is received on PFI 3. | - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigDigEdgeSource.PXI_STAR` | PXI_Star | The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646. | - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigDigEdgeSource.PXI_TRIG0` | PXI_Trig0 | The trigger is received on PXI trigger line 0. | - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigDigEdgeSource.PXI_TRIG1` | PXI_Trig1 | The trigger is received on PXI trigger line 1. | - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigDigEdgeSource.PXI_TRIG2` | PXI_Trig2 | The trigger is received on PXI trigger line 2. | - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigDigEdgeSource.PXI_TRIG3` | PXI_Trig3 | The trigger is received on PXI trigger line 3. | - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigDigEdgeSource.PXI_TRIG4` | PXI_Trig4 | The trigger is received on PXI trigger line 4. | - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigDigEdgeSource.PXI_TRIG5` | PXI_Trig5 | The trigger is received on PXI trigger line 5. | - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigDigEdgeSource.PXI_TRIG6` | PXI_Trig6 | The trigger is received on PXI trigger line 6. | - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigDigEdgeSource.PXI_TRIG7` | PXI_Trig7 | The trigger is received on PXI trigger line 7. | - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigDigEdgeSource.PXIE_DSTARB` | PXIe_DStarB | The trigger is received on the PXI DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. | - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigDigEdgeSource.TRIG_IN` | TrigIn | The trigger is received on the TRIG IN/OUT terminal. This value is valid on only the PXIe-5654/5654 with PXIe-5696. | - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigDigEdgeSource.DIO0` | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigDigEdgeSource.DIO1` | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigDigEdgeSource.DIO2` | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigDigEdgeSource.DIO3` | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigDigEdgeSource.DIO4` | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigDigEdgeSource.DIO5` | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigDigEdgeSource.DIO6` | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigDigEdgeSource.DIO7` | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigEdgeSource.SYNC_SCRIPT_TRIGGER` | Sync_Script | The trigger is received on the Sync Script trigger line. This value is valid on only the PXIe-5644/5645/5646. | - +----------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - - .. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. + **Possible Values**: + + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Possible Value | Description | + +================+========================================================================================================================================+ + | PFI0 | The trigger is received on PFI 0. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI1 | The trigger is received on PFI 1. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI2 | The trigger is received on PFI 2. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI3 | The trigger is received on PFI 3. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Star | The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig7 | The trigger is received on PXI trigger line 7. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXIe_DStarB | The trigger is received on the PXI DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | TrigIn | The trigger is received on the TRIG IN/OUT terminal. This value is valid on only the PXIe-5654/5654 with PXIe-5696. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Sync_Script | The trigger is received on the Sync Script trigger line. This value is valid on only the PXIe-5644/5645/5646. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ The following table lists the characteristics of this property. - +-----------------------+------------------------------+ - | Characteristic | Value | - +=======================+==============================+ - | Datatype | enums.StartTrigDigEdgeSource | - +-----------------------+------------------------------+ - | Permissions | read-write | - +-----------------------+------------------------------+ - | Repeated Capabilities | None | - +-----------------------+------------------------------+ + +-----------------------+------------+ + | Characteristic | Value | + +=======================+============+ + | Datatype | str | + +-----------------------+------------+ + | Permissions | read-write | + +-----------------------+------------+ + | Repeated Capabilities | None | + +-----------------------+------------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: @@ -5488,59 +5746,57 @@ digital_level_script_trigger_source `PXI Trigger Lines `_ - **Defined Values**: - - +---------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +=========================================================+=============+=========================================================================================================================================+ - | :py:data:`~nirfsg.ScriptTrigDigLevelSource.PFI0` | PFI0 | The trigger is received on PFI 0. | - +---------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigLevelSource.PFI1` | PFI1 | The trigger is received on PFI 1. | - +---------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigLevelSource.PFI2` | PFI2 | The trigger is received on PFI 2. | - +---------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigLevelSource.PFI3` | PFI3 | The trigger is received on PFI 3. | - +---------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigLevelSource.PXI_STAR` | PXI_Star | The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646. | - +---------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigLevelSource.PXI_TRIG0` | PXI_Trig0 | The trigger is received on PXI trigger line 0. | - +---------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigLevelSource.PXI_TRIG1` | PXI_Trig1 | The trigger is received on PXI trigger line 1. | - +---------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigLevelSource.PXI_TRIG2` | PXI_Trig2 | The trigger is received on PXI trigger line 2. | - +---------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigLevelSource.PXI_TRIG3` | PXI_Trig3 | The trigger is received on PXI trigger line 3. | - +---------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigLevelSource.PXI_TRIG4` | PXI_Trig4 | The trigger is received on PXI trigger line 4. | - +---------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigLevelSource.PXI_TRIG5` | PXI_Trig5 | The trigger is received on PXI trigger line 5. | - +---------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigLevelSource.PXI_TRIG6` | PXI_Trig6 | The trigger is received on PXI trigger line 6. | - +---------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigLevelSource.PXI_TRIG7` | PXI_Trig7 | The trigger is received on PXI trigger line 7. | - +---------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigLevelSource.PXIE_DSTARB` | PXIe_DStarB | The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. | - +---------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigLevelSource.PULSE_IN` | PulseIn | The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842. | - +---------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigLevelSource.DIO0` | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | - +---------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigLevelSource.DIO1` | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | - +---------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigLevelSource.DIO2` | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | - +---------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigLevelSource.DIO3` | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | - +---------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigLevelSource.DIO4` | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | - +---------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigLevelSource.DIO5` | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | - +---------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigLevelSource.DIO6` | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | - +---------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigDigLevelSource.DIO7` | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | - +---------------------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - - .. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. + **Possible Values**: + + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | Possible Value | Description | + +================+=========================================================================================================================================+ + | PFI0 | The trigger is received on PFI 0. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI1 | The trigger is received on PFI 1. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI2 | The trigger is received on PFI 2. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI3 | The trigger is received on PFI 3. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Star | The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig7 | The trigger is received on PXI trigger line 7. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXIe_DStarB | The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PulseIn | The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ .. tip:: This property can be set/get on specific script_triggers within your :py:class:`nirfsg.Session` instance. @@ -5554,15 +5810,15 @@ digital_level_script_trigger_source The following table lists the characteristics of this property. - +-----------------------+--------------------------------+ - | Characteristic | Value | - +=======================+================================+ - | Datatype | enums.ScriptTrigDigLevelSource | - +-----------------------+--------------------------------+ - | Permissions | read-write | - +-----------------------+--------------------------------+ - | Repeated Capabilities | script_triggers | - +-----------------------+--------------------------------+ + +-----------------------+-----------------+ + | Characteristic | Value | + +=======================+=================+ + | Datatype | str | + +-----------------------+-----------------+ + | Permissions | read-write | + +-----------------------+-----------------+ + | Repeated Capabilities | script_triggers | + +-----------------------+-----------------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: @@ -5925,7 +6181,7 @@ done_event_terminal_name **High-Level Methods**: - - :py:meth:`nirfsg.Session.GetTerminalName` + - :py:meth:`nirfsg.Session.get_terminal_name` The following table lists the characteristics of this property. @@ -6011,45 +6267,43 @@ exported_configuration_settled_event_output_terminal `PXI Trigger Lines `_ - **Defined Values**: - - +----------------------------------------------------------------------------+-------------+--------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +============================================================================+=============+====================================================================================================================+ - | :py:data:`~nirfsg.ConfigurationSettledEventExportOutputTerm.DO_NOT_EXPORT` | | The signal is not exported. | - +----------------------------------------------------------------------------+-------------+--------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ConfigurationSettledEventExportOutputTerm.PXI_TRIG0` | PXI_Trig0 | The trigger is received on PXI trigger line 0. | - +----------------------------------------------------------------------------+-------------+--------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ConfigurationSettledEventExportOutputTerm.PXI_TRIG1` | PXI_Trig1 | The trigger is received on PXI trigger line 1. | - +----------------------------------------------------------------------------+-------------+--------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ConfigurationSettledEventExportOutputTerm.PXI_TRIG2` | PXI_Trig2 | The trigger is received on PXI trigger line 2. | - +----------------------------------------------------------------------------+-------------+--------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ConfigurationSettledEventExportOutputTerm.PXI_TRIG3` | PXI_Trig3 | The trigger is received on PXI trigger line 3. | - +----------------------------------------------------------------------------+-------------+--------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ConfigurationSettledEventExportOutputTerm.PXI_TRIG4` | PXI_Trig4 | The trigger is received on PXI trigger line 4. | - +----------------------------------------------------------------------------+-------------+--------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ConfigurationSettledEventExportOutputTerm.PXI_TRIG5` | PXI_Trig5 | The trigger is received on PXI trigger line 5. | - +----------------------------------------------------------------------------+-------------+--------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ConfigurationSettledEventExportOutputTerm.PXI_TRIG6` | PXI_Trig6 | The trigger is received on PXI trigger line 6. | - +----------------------------------------------------------------------------+-------------+--------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ConfigurationSettledEventExportOutputTerm.PXIE_DSTARC` | PXIe_DStarC | The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5840/5841/5842. | - +----------------------------------------------------------------------------+-------------+--------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ConfigurationSettledEventExportOutputTerm.TRIG_OUT` | TrigOut | TRIG IN/OUT terminal. | - +----------------------------------------------------------------------------+-------------+--------------------------------------------------------------------------------------------------------------------+ - - .. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. + **Possible Values**: + + +----------------+--------------------------------------------------------------------------------------------------------------------+ + | Possible Value | Description | + +================+====================================================================================================================+ + | empty | The signal is not exported. | + +----------------+--------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + +----------------+--------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + +----------------+--------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + +----------------+--------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + +----------------+--------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + +----------------+--------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + +----------------+--------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + +----------------+--------------------------------------------------------------------------------------------------------------------+ + | PXIe_DStarC | The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5840/5841/5842. | + +----------------+--------------------------------------------------------------------------------------------------------------------+ + | TrigOut | TRIG IN/OUT terminal. | + +----------------+--------------------------------------------------------------------------------------------------------------------+ The following table lists the characteristics of this property. - +-----------------------+-------------------------------------------------+ - | Characteristic | Value | - +=======================+=================================================+ - | Datatype | enums.ConfigurationSettledEventExportOutputTerm | - +-----------------------+-------------------------------------------------+ - | Permissions | read-write | - +-----------------------+-------------------------------------------------+ - | Repeated Capabilities | None | - +-----------------------+-------------------------------------------------+ + +-----------------------+------------+ + | Characteristic | Value | + +=======================+============+ + | Datatype | str | + +-----------------------+------------+ + | Permissions | read-write | + +-----------------------+------------+ + | Repeated Capabilities | None | + +-----------------------+------------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: @@ -6080,67 +6334,65 @@ exported_done_event_output_terminal - :py:meth:`nirfsg.Session.export_signal` - **Defined Values**: - - +------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +============================================================+=============+=================================================================================================================================+ - | :py:data:`~nirfsg.DoneEventExportOutputTerm.DO_NOT_EXPORT` | | The signal is not exported. | - +------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DoneEventExportOutputTerm.PFI0` | PFI0 | The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. | - +------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DoneEventExportOutputTerm.PFI1` | PFI1 | The signal is exported to the PFI 1 connector. | - +------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DoneEventExportOutputTerm.PFI4` | PFI4 | The signal is exported to the PFI 4 connector. | - +------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DoneEventExportOutputTerm.PFI5` | PFI5 | The signal is exported to the PFI 5 connector. | - +------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DoneEventExportOutputTerm.PXI_TRIG0` | PXI_Trig0 | The trigger is received on PXI trigger line 0. | - +------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DoneEventExportOutputTerm.PXI_TRIG1` | PXI_Trig1 | The trigger is received on PXI trigger line 1. | - +------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DoneEventExportOutputTerm.PXI_TRIG2` | PXI_Trig2 | The trigger is received on PXI trigger line 2. | - +------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DoneEventExportOutputTerm.PXI_TRIG3` | PXI_Trig3 | The trigger is received on PXI trigger line 3. | - +------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DoneEventExportOutputTerm.PXI_TRIG4` | PXI_Trig4 | The trigger is received on PXI trigger line 4. | - +------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DoneEventExportOutputTerm.PXI_TRIG5` | PXI_Trig5 | The trigger is received on PXI trigger line 5. | - +------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DoneEventExportOutputTerm.PXI_TRIG6` | PXI_Trig6 | The trigger is received on PXI trigger line 6. | - +------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DoneEventExportOutputTerm.PXIE_DSTARC` | PXIe_DStarC | The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841. | - +------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DoneEventExportOutputTerm.DIO0` | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | - +------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DoneEventExportOutputTerm.DIO1` | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | - +------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DoneEventExportOutputTerm.DIO2` | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | - +------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DoneEventExportOutputTerm.DIO3` | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | - +------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DoneEventExportOutputTerm.DIO4` | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | - +------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DoneEventExportOutputTerm.DIO5` | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | - +------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DoneEventExportOutputTerm.DIO6` | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | - +------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DoneEventExportOutputTerm.DIO7` | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | - +------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - - .. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. + **Possible Values**: + + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | Posible Value | Description | + +===============+=================================================================================================================================+ + | empty | The signal is not exported. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PFI0 | The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PFI1 | The signal is exported to the PFI 1 connector. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PFI4 | The signal is exported to the PFI 4 connector. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PFI5 | The signal is exported to the PFI 5 connector. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXIe_DStarC | The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ The following table lists the characteristics of this property. - +-----------------------+---------------------------------+ - | Characteristic | Value | - +=======================+=================================+ - | Datatype | enums.DoneEventExportOutputTerm | - +-----------------------+---------------------------------+ - | Permissions | read-write | - +-----------------------+---------------------------------+ - | Repeated Capabilities | None | - +-----------------------+---------------------------------+ + +-----------------------+------------+ + | Characteristic | Value | + +=======================+============+ + | Datatype | str | + +-----------------------+------------+ + | Permissions | read-write | + +-----------------------+------------+ + | Repeated Capabilities | None | + +-----------------------+------------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: @@ -6169,55 +6421,53 @@ exported_marker_event_output_terminal - :py:meth:`nirfsg.Session.export_signal` - **Defined Values**: - - +--------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +==============================================================+=============+=================================================================================================================================+ - | :py:data:`~nirfsg.MarkerEventExportOutputTerm.DO_NOT_EXPORT` | | The signal is not exported. | - +--------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.MarkerEventExportOutputTerm.PFI0` | PFI0 | The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. | - +--------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.MarkerEventExportOutputTerm.PFI1` | PFI1 | The signal is exported to the PFI 1 connector. | - +--------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.MarkerEventExportOutputTerm.PFI4` | PFI4 | The signal is exported to the PFI 4 connector. | - +--------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.MarkerEventExportOutputTerm.PFI5` | PFI5 | The signal is exported to the PFI 5 connector. | - +--------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.MarkerEventExportOutputTerm.PXI_TRIG0` | PXI_Trig0 | The trigger is received on PXI trigger line 0. | - +--------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.MarkerEventExportOutputTerm.PXI_TRIG1` | PXI_Trig1 | The trigger is received on PXI trigger line 1. | - +--------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.MarkerEventExportOutputTerm.PXI_TRIG2` | PXI_Trig2 | The trigger is received on PXI trigger line 2. | - +--------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.MarkerEventExportOutputTerm.PXI_TRIG3` | PXI_Trig3 | The trigger is received on PXI trigger line 3. | - +--------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.MarkerEventExportOutputTerm.PXI_TRIG4` | PXI_Trig4 | The trigger is received on PXI trigger line 4. | - +--------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.MarkerEventExportOutputTerm.PXI_TRIG5` | PXI_Trig5 | The trigger is received on PXI trigger line 5. | - +--------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.MarkerEventExportOutputTerm.PXI_TRIG6` | PXI_Trig6 | The trigger is received on PXI trigger line 6. | - +--------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.MarkerEventExportOutputTerm.PXIE_DSTARC` | PXIe_DStarC | The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841. | - +--------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.MarkerEventExportOutputTerm.DIO0` | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | - +--------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.MarkerEventExportOutputTerm.DIO1` | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | - +--------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.MarkerEventExportOutputTerm.DIO2` | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | - +--------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.MarkerEventExportOutputTerm.DIO3` | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | - +--------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.MarkerEventExportOutputTerm.DIO4` | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | - +--------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.MarkerEventExportOutputTerm.DIO5` | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | - +--------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.MarkerEventExportOutputTerm.DIO6` | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | - +--------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.MarkerEventExportOutputTerm.DIO7` | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | - +--------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - - .. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. + **Possible Values**: + + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | Possible Value | Description | + +================+=================================================================================================================================+ + | empty | The signal is not exported. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PFI0 | The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PFI1 | The signal is exported to the PFI 1 connector. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PFI4 | The signal is exported to the PFI 4 connector. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PFI5 | The signal is exported to the PFI 5 connector. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXIe_DStarC | The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ .. tip:: This property can be set/get on specific markers within your :py:class:`nirfsg.Session` instance. @@ -6231,15 +6481,15 @@ exported_marker_event_output_terminal The following table lists the characteristics of this property. - +-----------------------+-----------------------------------+ - | Characteristic | Value | - +=======================+===================================+ - | Datatype | enums.MarkerEventExportOutputTerm | - +-----------------------+-----------------------------------+ - | Permissions | read-write | - +-----------------------+-----------------------------------+ - | Repeated Capabilities | markers | - +-----------------------+-----------------------------------+ + +-----------------------+------------+ + | Characteristic | Value | + +=======================+============+ + | Datatype | str | + +-----------------------+------------+ + | Permissions | read-write | + +-----------------------+------------+ + | Repeated Capabilities | markers | + +-----------------------+------------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: @@ -6293,33 +6543,33 @@ exported_pulse_modulation_event_output_terminal Specifies the destination terminal for exporting the Pulse Modulation Event. The Pulse Modulation Event tracks the RF Envelope when Pulse Modulation is Enabled. If this property is set to a value other than `do not export str`, calling NI-RFSG Commit will cause the output terminal to be pulled to the logic level that is the inverse of `exported pulse modulation event active level`. You can tri-state this terminal by setting this property to `do not export str` or by calling `niRFSG Reset`. To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** :py:data:`~nirfsg.PulseModulationOutputTerm.PULSE_OUT` + **Default Value:** :py:data:`~nirfsg.NIRFSG_VAL_PULSE_OUT_STR` **Supported Devices:** PXIe-5842 - **Defined Values**: + **Possible Values**: - +------------------------------------------------------------+----------+---------------------------------------------------------------------+ - | Name | Value | Description | - +============================================================+==========+=====================================================================+ - | :py:data:`~nirfsg.PulseModulationOutputTerm.DO_NOT_EXPORT` | | Pulse modulation video signal is not exported. | - +------------------------------------------------------------+----------+---------------------------------------------------------------------+ - | :py:data:`~nirfsg.PulseModulationOutputTerm.PULSE_OUT` | PulseOut | Export the pulse modulation video signal on the pulse out terminal. | - +------------------------------------------------------------+----------+---------------------------------------------------------------------+ + +----------------+---------------------------------------------------------------------+ + | Possible Value | Description | + +================+=====================================================================+ + | | Pulse modulation video signal is not exported. | + +----------------+---------------------------------------------------------------------+ + | PulseOut | Export the pulse modulation video signal on the pulse out terminal. | + +----------------+---------------------------------------------------------------------+ .. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. The following table lists the characteristics of this property. - +-----------------------+---------------------------------+ - | Characteristic | Value | - +=======================+=================================+ - | Datatype | enums.PulseModulationOutputTerm | - +-----------------------+---------------------------------+ - | Permissions | read-write | - +-----------------------+---------------------------------+ - | Repeated Capabilities | None | - +-----------------------+---------------------------------+ + +-----------------------+------------+ + | Characteristic | Value | + +=======================+============+ + | Datatype | str | + +-----------------------+------------+ + | Permissions | read-write | + +-----------------------+------------+ + | Repeated Capabilities | None | + +-----------------------+------------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: @@ -6334,53 +6584,53 @@ exported_ref_clock_output_terminal Specifies the destination terminal for exporting the Reference Clock on the RF signal generators. To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** :py:data:`~nirfsg.ReferenceClockExportOutputTerminal.DO_NOT_EXPORT` + **Possible Values**: - **Supported Devices:** PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + Possible Value: Description - **Related Topics** + "" :The Reference Clock signal is not exported. - `Interconnecting Multiple NI 5673E Modules `_ + RefOut :Exports the Reference Clock signal to the REF OUT connector of the device. - **Defined Values**: + RefOut2 :Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable. - Name (Value): Description + ClkOut :Exports the Reference Clock signal to the CLK OUT connector of the device. - :py:data:`~nirfsg.ReferenceClockExportOutputTerminal.DO_NOT_EXPORT` () :The Reference Clock signal is not exported. + **Default Value:** :py:data:`~nirfsg.NIRFSG_VAL_DO_NOT_EXPORT_STR` - :py:data:`~nirfsg.ReferenceClockExportOutputTerminal.REF_OUT` (RefOut) :Exports the Reference Clock signal to the REF OUT connector of the device. + **Supported Devices:** PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - :py:data:`~nirfsg.ReferenceClockExportOutputTerminal.REF_OUT2` (RefOut2) :Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable. + **Related Topics** - :py:data:`~nirfsg.ReferenceClockExportOutputTerminal.CLK_OUT` (ClkOut) :Exports the Reference Clock signal to the CLK OUT connector of the device. + `Interconnecting Multiple NI 5673E Modules `_ - +---------------------------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | Supported devices | - +=====================================================================+=========+============================================================================================+=======================================================================================================================================================================+ - | :py:data:`~nirfsg.ReferenceClockExportOutputTerminal.CLK_OUT` | ClkOut | Exports the Reference Clock signal to the CLK OUT connector of the device. | Supported on PXIe-5673, 5673E | - +---------------------------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ReferenceClockExportOutputTerminal.DO_NOT_EXPORT` | | The Reference Clock signal is not exported. | Supported on PXIe-5644/5645/5646, 5820/5830/5831/5832/5840/5841/5842/5860, 5650/5651/5652, 5654, 5673, 5673E, PXIe-5654 with PXIe-5696, PXI-5650/5651/5652 (See Note) | - +---------------------------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ReferenceClockExportOutputTerminal.REF_OUT` | RefOut | Exports the Reference Clock signal to the REF OUT connector of the device. | Supported on PXIe-5644/5645/5646, 5820/5830/5831/5832/5840/5841/5842/5860, 5650/5651/5653, 5653, 5654, 5673, 5673E, PXIe-5654 with PXIe-5696, PXI-5650/5651/5653, | - +---------------------------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ReferenceClockExportOutputTerminal.REF_OUT2` | RefOut2 | Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable. | Supported on PXIe-5650/5651/5652, 5654, 5673E, PXIe-5654 with PXIe-5696 | - +---------------------------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Value | Description | Supported devices | + +=================================================+=========+============================================================================================+=======================================================================================================================================================================+ + | :py:data:`~nirfsg.NIRFSG_VAL_CLK_OUT_STR` | ClkOut | Exports the Reference Clock signal to the CLK OUT connector of the device. | Supported on PXIe-5673, 5673E | + +-------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :py:data:`~nirfsg.NIRFSG_VAL_DO_NOT_EXPORT_STR` | empty | The Reference Clock signal is not exported. | Supported on PXIe-5644/5645/5646, 5820/5830/5831/5832/5840/5841/5842/5860, 5650/5651/5652, 5654, 5673, 5673E, PXIe-5654 with PXIe-5696, PXI-5650/5651/5652 (See Note) | + +-------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :py:data:`~nirfsg.NIRFSG_VAL_REF_OUT_STR` | RefOut | Exports the Reference Clock signal to the REF OUT connector of the device. | Supported on PXIe-5644/5645/5646, 5820/5830/5831/5832/5840/5841/5842/5860, 5650/5651/5653, 5653, 5654, 5673, 5673E, PXIe-5654 with PXIe-5696, PXI-5650/5651/5653, | + +-------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :py:data:`~nirfsg.NIRFSG_VAL_REF_OUT2_STR` | RefOut2 | Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable. | Supported on PXIe-5650/5651/5652, 5654, 5673E, PXIe-5654 with PXIe-5696 | + +-------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - .. note:: The :py:data:`~nirfsg.ReferenceClockExportOutputTerminal.REF_OUT2` output terminal value is valid for only the PXIe-5650/5651/5652, not the PXI-5650/5651/5652. + .. note:: The :py:data:`~nirfsg.NIRFSG_VAL_REF_OUT2_STR` output terminal value is valid for only the PXIe-5650/5651/5652, not the PXI-5650/5651/5652. .. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. The following table lists the characteristics of this property. - +-----------------------+------------------------------------------+ - | Characteristic | Value | - +=======================+==========================================+ - | Datatype | enums.ReferenceClockExportOutputTerminal | - +-----------------------+------------------------------------------+ - | Permissions | read-write | - +-----------------------+------------------------------------------+ - | Repeated Capabilities | None | - +-----------------------+------------------------------------------+ + +-----------------------+------------+ + | Characteristic | Value | + +=======================+============+ + | Datatype | str | + +-----------------------+------------+ + | Permissions | read-write | + +-----------------------+------------+ + | Repeated Capabilities | None | + +-----------------------+------------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: @@ -6452,55 +6702,53 @@ exported_script_trigger_output_terminal - :py:meth:`nirfsg.Session.export_signal` - **Defined Values**: - - +-------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +=============================================================+=============+=================================================================================================================================+ - | :py:data:`~nirfsg.ScriptTrigExportOutputTerm.DO_NOT_EXPORT` | | The signal is not exported. | - +-------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigExportOutputTerm.PFI0` | PFI0 | The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. | - +-------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigExportOutputTerm.PFI1` | PFI1 | The signal is exported to the PFI 1 connector. | - +-------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigExportOutputTerm.PFI4` | PFI4 | The signal is exported to the PFI 4 connector. | - +-------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigExportOutputTerm.PFI5` | PFI5 | The signal is exported to the PFI 5 connector. | - +-------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigExportOutputTerm.PXI_TRIG0` | PXI_Trig0 | The trigger is received on PXI trigger line 0. | - +-------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigExportOutputTerm.PXI_TRIG1` | PXI_Trig1 | The trigger is received on PXI trigger line 1. | - +-------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigExportOutputTerm.PXI_TRIG2` | PXI_Trig2 | The trigger is received on PXI trigger line 2. | - +-------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigExportOutputTerm.PXI_TRIG3` | PXI_Trig3 | The trigger is received on PXI trigger line 3. | - +-------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigExportOutputTerm.PXI_TRIG4` | PXI_Trig4 | The trigger is received on PXI trigger line 4. | - +-------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigExportOutputTerm.PXI_TRIG5` | PXI_Trig5 | The trigger is received on PXI trigger line 5. | - +-------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigExportOutputTerm.PXI_TRIG6` | PXI_Trig6 | The trigger is received on PXI trigger line 6. | - +-------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigExportOutputTerm.PXIE_DSTARC` | PXIe_DStarC | The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841. | - +-------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigExportOutputTerm.DIO0` | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | - +-------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigExportOutputTerm.DIO1` | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | - +-------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigExportOutputTerm.DIO2` | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | - +-------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigExportOutputTerm.DIO3` | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | - +-------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigExportOutputTerm.DIO4` | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | - +-------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigExportOutputTerm.DIO5` | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | - +-------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigExportOutputTerm.DIO6` | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | - +-------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ScriptTrigExportOutputTerm.DIO7` | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | - +-------------------------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - - .. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. + **Possible Values**: + + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | Possible Value | Description | + +================+=================================================================================================================================+ + | empty | The signal is not exported. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PFI0 | The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PFI1 | The signal is exported to the PFI 1 connector. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PFI4 | The signal is exported to the PFI 4 connector. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PFI5 | The signal is exported to the PFI 5 connector. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXIe_DStarC | The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ .. tip:: This property can be set/get on specific script_triggers within your :py:class:`nirfsg.Session` instance. @@ -6514,15 +6762,15 @@ exported_script_trigger_output_terminal The following table lists the characteristics of this property. - +-----------------------+----------------------------------+ - | Characteristic | Value | - +=======================+==================================+ - | Datatype | enums.ScriptTrigExportOutputTerm | - +-----------------------+----------------------------------+ - | Permissions | read-write | - +-----------------------+----------------------------------+ - | Repeated Capabilities | script_triggers | - +-----------------------+----------------------------------+ + +-----------------------+-----------------+ + | Characteristic | Value | + +=======================+=================+ + | Datatype | str | + +-----------------------+-----------------+ + | Permissions | read-write | + +-----------------------+-----------------+ + | Repeated Capabilities | script_triggers | + +-----------------------+-----------------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: @@ -6551,67 +6799,65 @@ exported_started_event_output_terminal - :py:meth:`nirfsg.Session.export_signal` - **Defined Values**: - - +---------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +===============================================================+=============+========================================================================================================================================+ - | :py:data:`~nirfsg.StartedEventExportOutputTerm.DO_NOT_EXPORT` | | The signal is not exported. | - +---------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartedEventExportOutputTerm.PFI0` | PFI0 | The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. | - +---------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartedEventExportOutputTerm.PFI1` | PFI1 | The signal is exported to the PFI 1 connector. | - +---------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartedEventExportOutputTerm.PFI4` | PFI4 | The signal is exported to the PFI 4 connector. | - +---------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartedEventExportOutputTerm.PFI5` | PFI5 | The signal is exported to the PFI 5 connector. | - +---------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartedEventExportOutputTerm.PXI_TRIG0` | PXI_Trig0 | The trigger is received on PXI trigger line 0. | - +---------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartedEventExportOutputTerm.PXI_TRIG1` | PXI_Trig1 | The trigger is received on PXI trigger line 1. | - +---------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartedEventExportOutputTerm.PXI_TRIG2` | PXI_Trig2 | The trigger is received on PXI trigger line 2. | - +---------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartedEventExportOutputTerm.PXI_TRIG3` | PXI_Trig3 | The trigger is received on PXI trigger line 3. | - +---------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartedEventExportOutputTerm.PXI_TRIG4` | PXI_Trig4 | The trigger is received on PXI trigger line 4. | - +---------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartedEventExportOutputTerm.PXI_TRIG5` | PXI_Trig5 | The trigger is received on PXI trigger line 5. | - +---------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartedEventExportOutputTerm.PXI_TRIG6` | PXI_Trig6 | The trigger is received on PXI trigger line 6. | - +---------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartedEventExportOutputTerm.PXIE_DSTARC` | PXIe_DStarC | The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. | - +---------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartedEventExportOutputTerm.DIO0` | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | - +---------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartedEventExportOutputTerm.DIO1` | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | - +---------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartedEventExportOutputTerm.DIO2` | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | - +---------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartedEventExportOutputTerm.DIO3` | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | - +---------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartedEventExportOutputTerm.DIO4` | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | - +---------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartedEventExportOutputTerm.DIO5` | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | - +---------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartedEventExportOutputTerm.DIO6` | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | - +---------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartedEventExportOutputTerm.DIO7` | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | - +---------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - - .. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. + **Possible Values**: + + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Possible Value | Description | + +================+========================================================================================================================================+ + | empty | The signal is not exported. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI0 | The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI1 | The signal is exported to the PFI 1 connector. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI4 | The signal is exported to the PFI 4 connector. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI5 | The signal is exported to the PFI 5 connector. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXIe_DStarC | The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ The following table lists the characteristics of this property. - +-----------------------+------------------------------------+ - | Characteristic | Value | - +=======================+====================================+ - | Datatype | enums.StartedEventExportOutputTerm | - +-----------------------+------------------------------------+ - | Permissions | read-write | - +-----------------------+------------------------------------+ - | Repeated Capabilities | None | - +-----------------------+------------------------------------+ + +-----------------------+------------+ + | Characteristic | Value | + +=======================+============+ + | Datatype | str | + +-----------------------+------------+ + | Permissions | read-write | + +-----------------------+------------+ + | Repeated Capabilities | None | + +-----------------------+------------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: @@ -6638,69 +6884,67 @@ exported_start_trigger_output_terminal `PXI Trigger Lines `_ - **Defined Values**: - - +------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +============================================================+=============+========================================================================================================================================+ - | :py:data:`~nirfsg.StartTrigExportOutputTerm.DO_NOT_EXPORT` | | The signal is not exported. | - +------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigExportOutputTerm.PFI0` | PFI0 | The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. | - +------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigExportOutputTerm.PFI1` | PFI1 | The signal is exported to the PFI 1 connector. | - +------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigExportOutputTerm.PFI4` | PFI4 | The signal is exported to the PFI 4 connector. | - +------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigExportOutputTerm.PFI5` | PFI5 | The signal is exported to the PFI 5 connector. | - +------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigExportOutputTerm.PXI_TRIG0` | PXI_Trig0 | The trigger is received on PXI trigger line 0. | - +------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigExportOutputTerm.PXI_TRIG1` | PXI_Trig1 | The trigger is received on PXI trigger line 1. | - +------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigExportOutputTerm.PXI_TRIG2` | PXI_Trig2 | The trigger is received on PXI trigger line 2. | - +------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigExportOutputTerm.PXI_TRIG3` | PXI_Trig3 | The trigger is received on PXI trigger line 3. | - +------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigExportOutputTerm.PXI_TRIG4` | PXI_Trig4 | The trigger is received on PXI trigger line 4. | - +------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigExportOutputTerm.PXI_TRIG5` | PXI_Trig5 | The trigger is received on PXI trigger line 5. | - +------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigExportOutputTerm.PXI_TRIG6` | PXI_Trig6 | The trigger is received on PXI trigger line 6. | - +------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigExportOutputTerm.PXIE_DSTARC` | PXIe_DStarC | The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. | - +------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigExportOutputTerm.TRIG_OUT` | TrigOut | The signal is exported to the TRIG IN/OUT terminal. This value is valid on only the PXIe-5654/5654 with PXIe-5696. | - +------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigExportOutputTerm.DIO0` | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | - +------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigExportOutputTerm.DIO1` | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | - +------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigExportOutputTerm.DIO2` | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | - +------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigExportOutputTerm.DIO3` | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | - +------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigExportOutputTerm.DIO4` | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | - +------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigExportOutputTerm.DIO5` | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | - +------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigExportOutputTerm.DIO6` | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | - +------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.StartTrigExportOutputTerm.DIO7` | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | - +------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - - .. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. + **Possible Values**: + + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Possible Value | Description | + +================+========================================================================================================================================+ + | empty | The signal is not exported. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI0 | The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI1 | The signal is exported to the PFI 1 connector. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI4 | The signal is exported to the PFI 4 connector. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI5 | The signal is exported to the PFI 5 connector. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXIe_DStarC | The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | TrigOut | The signal is exported to the TRIG IN/OUT terminal. This value is valid on only the PXIe-5654/5654 with PXIe-5696. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ The following table lists the characteristics of this property. - +-----------------------+---------------------------------+ - | Characteristic | Value | - +=======================+=================================+ - | Datatype | enums.StartTrigExportOutputTerm | - +-----------------------+---------------------------------+ - | Permissions | read-write | - +-----------------------+---------------------------------+ - | Repeated Capabilities | None | - +-----------------------+---------------------------------+ + +-----------------------+------------+ + | Characteristic | Value | + +=======================+============+ + | Datatype | str | + +-----------------------+------------+ + | Permissions | read-write | + +-----------------------+------------+ + | Repeated Capabilities | None | + +-----------------------+------------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: @@ -8139,13 +8383,13 @@ load_configurations_from_file_load_options **Defined Values**: - +---------------------------------------------+-------------------------------------------------------------------+ - | Value | Description | - +=============================================+===================================================================+ - | :py:data:`~nirfsg.NIRFSG_VAL_SKIP_NONE` | NI-RFSG loads all the configurations to the session. | - +---------------------------------------------+-------------------------------------------------------------------+ - | :py:data:`~nirfsg.NIRFSG_VAL_SKIP_WAVEFORM` | NI-RFSG skips loading the waveform configurations to the session. | - +---------------------------------------------+-------------------------------------------------------------------+ + +--------------------------------------------------------------------+-------------------------------------------------------------------+ + | Value | Description | + +====================================================================+===================================================================+ + | RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_LOAD_OPTIONS_SKIP_NONE | NI-RFSG loads all the configurations to the session. | + +--------------------------------------------------------------------+-------------------------------------------------------------------+ + | RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_LOAD_OPTIONS_SKIP_WAVEFORMS | NI-RFSG skips loading the waveform configurations to the session. | + +--------------------------------------------------------------------+-------------------------------------------------------------------+ .. 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. @@ -8179,17 +8423,17 @@ load_configurations_from_file_reset_options **Defined Values**: - +-------------------------------------------------------+------------------------------------------------------+ - | Value | Description | - +=======================================================+======================================================+ - | :py:data:`~nirfsg.NIRFSG_VAL_SKIP_NONE` | NI-RFSG resets all configurations. | - +-------------------------------------------------------+------------------------------------------------------+ - | :py:data:`~nirfsg.NIRFSG_VAL_SKIP_WAVEFORMS` | NI-RFSG skips resetting the waveform configurations. | - +-------------------------------------------------------+------------------------------------------------------+ - | :py:data:`~nirfsg.NIRFSG_VAL_SKIP_SCRIPTS` | NI-RFSG skips resetting the scripts. | - +-------------------------------------------------------+------------------------------------------------------+ - | :py:data:`~nirfsg.NIRFSG_VAL_SKIP_DEEMBEDDING_TABLES` | NI-RFSG skips resetting the de-embedding tables. | - +-------------------------------------------------------+------------------------------------------------------+ + +------------------------------------------------------------------------------+------------------------------------------------------+ + | Value | Description | + +==============================================================================+======================================================+ + | RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_NONE | NI-RFSG resets all configurations. | + +------------------------------------------------------------------------------+------------------------------------------------------+ + | RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_WAVEFORMS | NI-RFSG skips resetting the waveform configurations. | + +------------------------------------------------------------------------------+------------------------------------------------------+ + | RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_SCRIPTS | NI-RFSG skips resetting the scripts. | + +------------------------------------------------------------------------------+------------------------------------------------------+ + | RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_DEEMBEDDING_TABLES | NI-RFSG skips resetting the de-embedding tables. | + +------------------------------------------------------------------------------+------------------------------------------------------+ .. 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. @@ -8585,7 +8829,7 @@ lo_pll_fractional_mode_enabled Specifies whether to use fractional mode for the local oscillator (LO) phase-locked loop (PLL). This property enables or disables fractional frequency tuning in the LO. Fractional mode provides a finer frequency step resolution and allows smaller values for the :py:attr:`nirfsg.Session.lo_frequency_step_size` property. However, fractional mode may introduce non-harmonic spurs. - This property applies only if you set the :py:attr:`nirfsg.Session.lo_source` property to :py:data:`~nirfsg.LoSource.ONBOARD`. + This property applies only if you set the :py:attr:`nirfsg.Session.lo_source` property to :py:data:`~nirfsg.NIRFSG_VAL_LO_SOURCE_ONBOARD_STR`. To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the :py:meth:`nirfsg.Session._set_attribute_vi_int32` method to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string). @@ -8638,7 +8882,7 @@ lo_source To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the :py:meth:`nirfsg.Session._set_attribute_vi_string` method to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string). - **Default Value:** :py:data:`~nirfsg.LoSource.ONBOARD` + **Default Value:** :py:data:`~nirfsg.NIRFSG_VAL_LO_SOURCE_ONBOARD_STR` **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842 @@ -8648,35 +8892,37 @@ lo_source `PXIe-5831/5832 LO Sharing Using NI-RFSA and NI-RFSG `_ - **Defined Values**: + **Possible Values**: - +----------------------------------------------------+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +====================================================+========================+==================================================================================================================================================================================================================================================================+ - | :py:data:`~nirfsg.LoSource.AUTOMATIC_SG_SA_SHARED` | Automatic_SG_SA_Shared | NI-RFSG internally makes the configuration to share the LO between NI-RFSA and NI-RFSG. This value is valid only on the PXIe-5820/5830/5831/5832/5840/5841/5842. | - +----------------------------------------------------+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.LoSource.LO_IN` | LO_In | Uses an external LO as the LO source. Connect a signal to the LO IN connector on the device and use the :py:attr:`nirfsg.Session.upconverter_center_frequency` property to specify the LO frequency. | - +----------------------------------------------------+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.LoSource.ONBOARD` | Onboard | Uses an internal LO as the LO source. If you specify an internal LO source, the LO is generated inside the device itself. | - +----------------------------------------------------+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.LoSource.SG_SA_SHARED` | SG_SA_Shared | Uses the same internal LO during NI-RFSA and NI-RFSG sessions. NI-RFSG selects an internal synthesizer and the synthesizer signal is switched to both the RF In and RF Out mixers. This value is valid only on the PXIe-5830/5831/5832/5841 with PXIe-5655/5842. | - +----------------------------------------------------+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.LoSource.SECONDARY` | Secondary | Uses the PXIe-5831/5840 internal LO as the LO source. This value is valid only on the PXIe-5831 with PXIe-5653 and PXIe-5832 with PXIe-5653. | - +----------------------------------------------------+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Possible Value | Description | + +========================+==================================================================================================================================================================================================================================================================+ + | Automatic_SG_SA_Shared | NI-RFSG internally makes the configuration to share the LO between NI-RFSA and NI-RFSG. This value is valid only on the PXIe-5820/5830/5831/5832/5840/5841/5842. | + +------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | LO_In | Uses an external LO as the LO source. Connect a signal to the LO IN connector on the device and use the :py:attr:`nirfsg.Session.upconverter_center_frequency` property to specify the LO frequency. | + +------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Onboard | Uses an internal LO as the LO source. If you specify an internal LO source, the LO is generated inside the device itself. | + +------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | SG_SA_Shared | Uses the same internal LO during NI-RFSA and NI-RFSG sessions. NI-RFSG selects an internal synthesizer and the synthesizer signal is switched to both the RF In and RF Out mixers. This value is valid only on the PXIe-5830/5831/5832/5841 with PXIe-5655/5842. | + +------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Secondary | Uses the PXIe-5831/5840 internal LO as the LO source. This value is valid only on the PXIe-5831 with PXIe-5653 and PXIe-5832 with PXIe-5653. | + +------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - .. note:: For the PXIe-5841 with PXIe-5655, RF list mode is not supported when this property is set to :py:data:`~nirfsg.LoSource.SG_SA_SHARED`. + .. note:: For the PXIe-5841 with PXIe-5655, RF list mode is not supported when this property is set to :py:data:`~nirfsg.NIRFSG_VAL_LO_SOURCE_SG_SA_SHARED_STR`. + + .. 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.LoSource | - +-----------------------+----------------+ - | Permissions | read-write | - +-----------------------+----------------+ - | Repeated Capabilities | None | - +-----------------------+----------------+ + +-----------------------+------------+ + | Characteristic | Value | + +=======================+============+ + | Datatype | str | + +-----------------------+------------+ + | Permissions | read-write | + +-----------------------+------------+ + | Repeated Capabilities | None | + +-----------------------+------------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: @@ -8930,7 +9176,7 @@ marker_event_terminal_name **High-Level Methods**: - - :py:meth:`nirfsg.Session.GetTerminalName` + - :py:meth:`nirfsg.Session.get_terminal_name` @@ -10117,39 +10363,39 @@ pulse_modulation_source Specifies the source of the pulse modulation signal. When Pulse In in used, the pulse modulation is applied with the lowest latency and jitter, but is not aligned to any particular waveform sample. When a marker is used, the RF pulse is aligned to a specific sample in the arbitrary waveform. To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** :py:data:`~nirfsg.PulseModulationSource.PULSE_IN` + **Default Value:** :py:data:`~nirfsg.NIRFSG_VAL_PULSE_IN_STR` **Supported Devices:** PXIe-5842 - **Defined Values**: - - +---------------------------------------------------+---------+----------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +===================================================+=========+==============================================================================================+ - | :py:data:`~nirfsg.PulseModulationSource.PULSE_IN` | PulseIn | The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842. | - +---------------------------------------------------+---------+----------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.PulseModulationSource.MARKER0` | | The trigger is received from the Marker 0. | - +---------------------------------------------------+---------+----------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.PulseModulationSource.MARKER1` | | The trigger is received from the Marker 1. | - +---------------------------------------------------+---------+----------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.PulseModulationSource.MARKER2` | | The trigger is received from the Marker 2. | - +---------------------------------------------------+---------+----------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.PulseModulationSource.MARKER3` | | The trigger is received from the Marker 3. | - +---------------------------------------------------+---------+----------------------------------------------------------------------------------------------+ + **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. | + +----------------+----------------------------------------------------------------------------------------------+ .. 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.PulseModulationSource | - +-----------------------+-----------------------------+ - | Permissions | read-write | - +-----------------------+-----------------------------+ - | Repeated Capabilities | None | - +-----------------------+-----------------------------+ + +-----------------------+------------+ + | Characteristic | Value | + +=======================+============+ + | Datatype | str | + +-----------------------+------------+ + | Permissions | read-write | + +-----------------------+------------+ + | Repeated Capabilities | None | + +-----------------------+------------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: @@ -10164,17 +10410,17 @@ 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. - **Defined Values**: + **Possible Values**: - Name (Value): Description + Possible Value: Description - :py:data:`~nirfsg.PxiChassisClk10Source.NONE` (0) :Do not drive the PXI_CLK10 signal. + empty :Do not drive the PXI_CLK10 signal. - :py:data:`~nirfsg.PxiChassisClk10Source.ONBOARD_CLOCK_STR` (OnboardClock) :Uses the highly stable oven-controlled onboard Reference Clock to drive the PXI_CLK signal. + OnboardClock :Uses the highly stable oven-controlled onboard Reference Clock to drive the PXI_CLK signal. - :py:data:`~nirfsg.PxiChassisClk10Source.REF_IN_STR` (RefIn) :Uses the clock present at the front panel REF IN connector to drive the PXI_CLK signal. + RefIn :Uses the clock present at the front panel REF IN connector to drive the PXI_CLK signal. - **Default Value:** :py:data:`~nirfsg.PxiChassisClk10Source.NONE` + **Default Value:** empty **Supported Devices:** PXI-5610, PXI-5670/5671 @@ -10191,29 +10437,27 @@ pxi_chassis_clk10_source 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 | - +===========================================================================================================+============================================================+ - | :py:data:`~nirfsg.PxiChassisClk10Source.NONE`, :py:data:`~nirfsg.PxiChassisClk10Source.ONBOARD_CLOCK_STR` | :py:data:`~nirfsg.PxiChassisClk10Source.ONBOARD_CLOCK_STR` | - +-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------+ - | :py:data:`~nirfsg.PxiChassisClk10Source.NONE`, :py:data:`~nirfsg.PxiChassisClk10Source.REF_IN_STR` | :py:data:`~nirfsg.PxiChassisClk10Source.REF_IN_STR` | - +-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------+ - | :py:data:`~nirfsg.PxiChassisClk10Source.NONE`, :py:data:`~nirfsg.PxiChassisClk10Source.REF_IN_STR` | :py:data:`~nirfsg.ReferenceClockSource.PXI_CLK` | - +-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------+ - - .. 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. + +------------------------------------------------------------+----------------------------------------------------+ + | :py:attr:`nirfsg.Session.pxi_chassis_clk10_source` Setting | :py:attr:`nirfsg.Session.ref_clock_source` Setting | + +============================================================+====================================================+ + | empty, OnboardClock | OnboardClock | + +------------------------------------------------------------+----------------------------------------------------+ + | empty, RefIn | RefIn | + +------------------------------------------------------------+----------------------------------------------------+ + | empty, RefIn | PXI_CLK | + +------------------------------------------------------------+----------------------------------------------------+ The following table lists the characteristics of this property. - +-----------------------+-----------------------------+ - | Characteristic | Value | - +=======================+=============================+ - | Datatype | enums.PxiChassisClk10Source | - +-----------------------+-----------------------------+ - | Permissions | read-write | - +-----------------------+-----------------------------+ - | Repeated Capabilities | None | - +-----------------------+-----------------------------+ + +-----------------------+------------+ + | Characteristic | Value | + +=======================+============+ + | Datatype | str | + +-----------------------+------------+ + | Permissions | read-write | + +-----------------------+------------+ + | Repeated Capabilities | None | + +-----------------------+------------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: @@ -10347,7 +10591,7 @@ ref_clock_rate .. py:attribute:: ref_clock_rate - Specifies the Reference Clock rate, in Hz, of the signal present at the REF IN or CLK IN connector. This property is only valid when the :py:attr:`nirfsg.Session.ref_clock_source` property is set to :py:data:`~nirfsg.NIRFSG_VAL_CLK_IN_STR`, :py:data:`~nirfsg.NIRFSG_VAL_REF_IN_STR`, or :py:data:`~nirfsg.ReferenceClockSource.REF_IN_2` + Specifies the Reference Clock rate, in Hz, of the signal present at the REF IN or CLK IN connector. This property is only valid when the :py:attr:`nirfsg.Session.ref_clock_source` property is set to :py:data:`~nirfsg.NIRFSG_VAL_CLK_IN_STR`, :py:data:`~nirfsg.NIRFSG_VAL_REF_IN_STR`, or :py:data:`~nirfsg.NIRFSG_VAL_REF_IN_2_STR` To set this property, the NI-RFSG device must be in the Configuration state. If you are using the PXIe-5654/5654 with PXIe-5696, the NI-RFSG device must be in the Committed state to read this property. When you read this property, it returns the frequency the device is locked to during the Committed state. @@ -10418,7 +10662,7 @@ ref_clock_source Specifies the Reference Clock source. To set this property, the NI-RFSG device must be in the Configuration state. Only certain combinations of this property and the :py:attr:`nirfsg.Session.pxi_chassis_clk10_source` property are valid, as shown in the following table. - **Default Value:** :py:data:`~nirfsg.ReferenceClockSource.ONBOARD_CLOCK` + **Default Value:** :py:data:`~nirfsg.NIRFSG_VAL_ONBOARD_CLOCK_STR` **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 @@ -10430,23 +10674,23 @@ ref_clock_source - :py:meth:`nirfsg.Session.configure_ref_clock` - **Defined Values**: - - +--------------------------------------------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +========================================================+===============+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | :py:data:`~nirfsg.ReferenceClockSource.ONBOARD_CLOCK` | OnboardClock | Uses the onboard Reference Clock as the clock source. **PXIe-5830/5831** —For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831/5832, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. ** PXIe-5831/5832 with PXIe-5653** —Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector. **PXIe-5841 with PXIe-5655** —Lock to the PXIe-5655 onboard clock. Connect the REF OUT connector on the PXIe-5655 to the PXIe-5841 REF IN connector. | - +--------------------------------------------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ReferenceClockSource.CLK_IN` | ClkIn | Uses the clock signal present at the front panel CLK IN connector as the Reference Clock source. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5831 with PXIe-5653/5832/5832 with PXIe-5653/5840/5841/5841 with PXIe-5655. | - +--------------------------------------------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ReferenceClockSource.REF_IN` | RefIn | Uses the clock signal present at the front panel REF IN connector as the Reference Clock source. **PXIe-5830/5831** —For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831/5832, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. For the PXIe-5830, lock the external signal to the PXIe-3621 REF IN connector. For the PXIe-5831/5832, lock the external signal to the PXIe-3622 REF IN connector. **PXIe-5831/5832 with PXIe-5653** —Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector. Lock the external signal to the PXIe-5653 REF IN connector. **PXIe-5841 with PXIe-5655** —Lock to the signal at the REF IN connector on the associated PXIe-5655. Connect the PXIe-5655 REF OUT connector to the PXIe-5841 REF IN connector. | - +--------------------------------------------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ReferenceClockSource.PXI_CLK` | PXI_CLK | Uses the PXI_CLK signal, which is present on the PXI backplane, as the Reference Clock source. | - +--------------------------------------------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ReferenceClockSource.REF_IN_2` | RefIn2 | This value is not valid on any supported devices. | - +--------------------------------------------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.ReferenceClockSource.PXI_CLK_MASTER` | PXI_ClkMaster | This value is valid on only the PXIe-5831/5832 with PXIe-5653. **PXIe-5831/5832 with PXIe-5653** —NI-RFSG configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3622 to use :py:data:`~nirfsg.ReferenceClockSource.PXI_CLK` as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector. | - +--------------------------------------------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + **Possible Values**: + + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Possible Value | Description | + +================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | OnboardClock | Uses the onboard Reference Clock as the clock source. **PXIe-5830/5831** —For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831/5832, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. ** PXIe-5831/5832 with PXIe-5653** —Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector. **PXIe-5841 with PXIe-5655** —Lock to the PXIe-5655 onboard clock. Connect the REF OUT connector on the PXIe-5655 to the PXIe-5841 REF IN connector. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ClkIn | Uses the clock signal present at the front panel CLK IN connector as the Reference Clock source. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5831 with PXIe-5653/5832/5832 with PXIe-5653/5840/5841/5841 with PXIe-5655. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | RefIn | Uses the clock signal present at the front panel REF IN connector as the Reference Clock source. **PXIe-5830/5831** —For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831/5832, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. For the PXIe-5830, lock the external signal to the PXIe-3621 REF IN connector. For the PXIe-5831/5832, lock the external signal to the PXIe-3622 REF IN connector. **PXIe-5831/5832 with PXIe-5653** —Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector. Lock the external signal to the PXIe-5653 REF IN connector. **PXIe-5841 with PXIe-5655** —Lock to the signal at the REF IN connector on the associated PXIe-5655. Connect the PXIe-5655 REF OUT connector to the PXIe-5841 REF IN connector. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_CLK | Uses the PXI_CLK signal, which is present on the PXI backplane, as the Reference Clock source. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | RefIn2 | This value is not valid on any supported devices. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_ClkMaster | This value is valid on only the PXIe-5831/5832 with PXIe-5653. **PXIe-5831/5832 with PXIe-5653** —NI-RFSG configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3622 to use :py:data:`~nirfsg.NIRFSG_VAL_PXI_CLK_STR` as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. 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. @@ -10454,15 +10698,15 @@ ref_clock_source The following table lists the characteristics of this property. - +-----------------------+----------------------------+ - | Characteristic | Value | - +=======================+============================+ - | Datatype | enums.ReferenceClockSource | - +-----------------------+----------------------------+ - | Permissions | read-write | - +-----------------------+----------------------------+ - | Repeated Capabilities | None | - +-----------------------+----------------------------+ + +-----------------------+------------+ + | Characteristic | Value | + +=======================+============+ + | Datatype | str | + +-----------------------+------------+ + | Permissions | read-write | + +-----------------------+------------+ + | Repeated Capabilities | None | + +-----------------------+------------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: @@ -10579,7 +10823,7 @@ rf_blanking_source PXIe-5840/5841: RF blanking does not occur for frequencies below 120MHz. - For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any :py:meth:`nirfsg.Session.reset` or `niRFSA_reset `_ on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call :py:meth:`nirfsg.Session.ResetWithOptions` or `niRFSA_ResetWithOptions `_. Select **Routes** in the **steps to omit** parameter. + For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any :py:meth:`nirfsg.Session.reset` or `niRFSA_reset `_ on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call :py:meth:`nirfsg.Session.reset_with_options` or `niRFSA_ResetWithOptions `_. Select **Routes** in the **steps to omit** parameter. **Default Value:** "" (empty string) @@ -10634,7 +10878,7 @@ rf_in_lo_export_enabled Set this property to :py:data:`~nirfsg.RFInLoExportEnabled.ENABLE` to export the LO signal from the RF IN LO OUT terminal. - When this property is enabled, if the :py:attr:`nirfsg.Session.lo_source` property is set to :py:data:`~nirfsg.LoSource.LO_IN` and you do not set the :py:attr:`nirfsg.Session.lo_frequency` or :py:attr:`nirfsg.Session.upconverter_center_frequency` properties, NI-RFSG rounds the LO frequency to approximately an LO step size as if the source was :py:data:`~nirfsg.NIRFSG_VAL_ONBOARD_CLOCK_STR`. This ensures that when you configure NI-RFSA and NI-RFSG with compatible settings that result in the same LO frequency, the rounding also is compatible. + When this property is enabled, if the :py:attr:`nirfsg.Session.lo_source` property is set to :py:data:`~nirfsg.NIRFSG_VAL_LO_SOURCE_LO_IN_STR` and you do not set the :py:attr:`nirfsg.Session.lo_frequency` or :py:attr:`nirfsg.Session.upconverter_center_frequency` properties, NI-RFSG rounds the LO frequency to approximately an LO step size as if the source was :py:data:`~nirfsg.NIRFSG_VAL_ONBOARD_CLOCK_STR`. This ensures that when you configure NI-RFSA and NI-RFSG with compatible settings that result in the same LO frequency, the rounding also is compatible. **Default Value:** :py:data:`~nirfsg.RFInLoExportEnabled.UNSPECIFIED` @@ -10699,7 +10943,7 @@ script_trigger_terminal_name **High-Level Methods**: - - :py:meth:`nirfsg.Session.GetTerminalName` + - :py:meth:`nirfsg.Session.get_terminal_name` @@ -11244,7 +11488,7 @@ started_event_terminal_name **High-Level Methods**: - - :py:meth:`nirfsg.Session.GetTerminalName` + - :py:meth:`nirfsg.Session.get_terminal_name` The following table lists the characteristics of this property. @@ -11293,7 +11537,7 @@ start_trigger_terminal_name **High-Level Methods**: - - :py:meth:`nirfsg.Session.GetTerminalName` + - :py:meth:`nirfsg.Session.get_terminal_name` The following table lists the characteristics of this property. @@ -12264,7 +12508,7 @@ waveform_rf_blanking | :py:data:`~nirfsg.NIRFSG_VAL_MARKER0`, :py:data:`~nirfsg.NIRFSG_VAL_MARKER1`, :py:data:`~nirfsg.NIRFSG_VAL_MARKER2`, or :py:data:`~nirfsg.NIRFSG_VAL_MARKER3` | :py:data:`~nirfsg.RFBlanking.ENABLE` | Error is shown. | +---------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ - .. note:: For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any :py:meth:`nirfsg.Session.reset` or `niRFSA_reset `_ on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call :py:meth:`nirfsg.Session.ResetWithOptions` or `niRFSA_ResetWithOptions `_. Select **Routes** in the **steps to omit** parameter. + .. note:: For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any :py:meth:`nirfsg.Session.reset` or `niRFSA_reset `_ on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call :py:meth:`nirfsg.Session.reset_with_options` or `niRFSA_ResetWithOptions `_. Select **Routes** in the **steps to omit** parameter. .. 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. @@ -12422,7 +12666,7 @@ write_waveform_burst_detection .. py:attribute:: write_waveform_burst_detection - Enables the detection of burst start and burst stop locations in the waveform. You can read the detected burst start and burst stop locations using :py:meth:`nirfsg.Session._get_waveform_burst_start_locations` and :py:meth:`nirfsg.Session._get_waveform_burst_stop_locations` methods respectively. + Enables the detection of burst start and burst stop locations in the waveform. You can read the detected burst start and burst stop locations using :py:meth:`nirfsg.Session.GetWaveformBurstStartLocations` and :py:meth:`nirfsg.Session.GetWaveformBurstStopLocations` methods respectively. **Default Value:** :py:data:`~nirfsg.WriteWaveformBurstDetection.DISABLE` @@ -12440,7 +12684,7 @@ write_waveform_burst_detection .. note:: - When you download a waveform using :py:meth:`nirfsg.Session.ReadAndDownloadWaveformFromFileTdms` method and if :py:attr:`nirfsg.Session.waveform_rf_blanking` property is enabled, you must set the :py:attr:`nirfsg.Session.write_waveform_burst_detection` property to :py:data:`~nirfsg.WriteWaveformBurstDetection.DISABLE`. - - For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any :py:meth:`nirfsg.Session.reset` or `niRFSA_reset `_ on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call :py:meth:`nirfsg.Session.ResetWithOptions` or `niRFSA_ResetWithOptions `_. Select **Routes** in the **steps to omit** parameter. + - For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any :py:meth:`nirfsg.Session.reset` or `niRFSA_reset `_ on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call :py:meth:`nirfsg.Session.reset_with_options` or `niRFSA_ResetWithOptions `_. Select **Routes** in the **steps to omit** parameter. .. 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. diff --git a/docs/nirfsg/enums.rst b/docs/nirfsg/enums.rst index f92d56709..e48744908 100644 --- a/docs/nirfsg/enums.rst +++ b/docs/nirfsg/enums.rst @@ -246,31 +246,6 @@ ArbOnboardSampleClockMode -ArbSampleClockSource --------------------- - -.. py:class:: ArbSampleClockSource - - .. py:attribute:: ArbSampleClockSource.ONBOARD_CLOCK - - - - Uses the AWG module onboard clock as the Sample Clock source. - - - - - - .. py:attribute:: ArbSampleClockSource.CLK_IN - - - - Uses the external clock as the Sample Clock source. - - - - - AutomaticLevelControl --------------------- @@ -361,4437 +336,1616 @@ ConfigListTrigDigEdgeEdge -ConfigListTrigDigEdgeSource ---------------------------- +ConfigListTrigType +------------------ -.. py:class:: ConfigListTrigDigEdgeSource +.. py:class:: ConfigListTrigType - .. py:attribute:: ConfigListTrigDigEdgeSource.PFI0 + .. py:attribute:: ConfigListTrigType.NONE - The trigger is received on PFI 0. + Generation starts immediately, but the list does not advance. - .. py:attribute:: ConfigListTrigDigEdgeSource.PFI1 + .. py:attribute:: ConfigListTrigType.DIGITAL_EDGE - The trigger is received on PFI 1. + Data operation does not start until a digital edge is detected. The source of the digital edge is specified in the :py:attr:`nirfsg.Session.DIGITAL_EDGE_CONFIGURATION_LIST_STEP_TRIGGER_SOURCE` property, and the active edge is always rising. - .. py:attribute:: ConfigListTrigDigEdgeSource.PXI_TRIG0 - - +ConfigurationListRepeat +----------------------- - The trigger is received on PXI trigger line 0. +.. py:class:: ConfigurationListRepeat - + .. py:attribute:: ConfigurationListRepeat.CONFIGURATION_LIST_REPEAT_CONTINUOUS - .. py:attribute:: ConfigListTrigDigEdgeSource.PXI_TRIG1 + NI-RFSG runs the configuration list continuously. + - The trigger is received on PXI trigger line 1. - + .. py:attribute:: ConfigurationListRepeat.MANUAL - .. py:attribute:: ConfigListTrigDigEdgeSource.PXI_TRIG2 + .. py:attribute:: ConfigurationListRepeat.CONFIGURATION_LIST_REPEAT_SINGLE - The trigger is received on PXI trigger line 2. + NI-RFSG runs the configuration list only once. - .. py:attribute:: ConfigListTrigDigEdgeSource.PXI_TRIG3 - - + .. py:attribute:: ConfigurationListRepeat.SCRIPT_TRIGGER - The trigger is received on PXI trigger line 3. - +DeembeddingTypeAttrVals +----------------------- +.. py:class:: DeembeddingTypeAttrVals - .. py:attribute:: ConfigListTrigDigEdgeSource.PXI_TRIG4 + .. py:attribute:: DeembeddingTypeAttrVals.NONE - The trigger is received on PXI trigger line 4. + De-embedding is not applied to the measurement. - .. py:attribute:: ConfigListTrigDigEdgeSource.PXI_TRIG5 + .. py:attribute:: DeembeddingTypeAttrVals.SCALAR - The trigger is received on PXI trigger line 5. + De-embeds the measurement using only the gain term. - .. py:attribute:: ConfigListTrigDigEdgeSource.PXI_TRIG6 + .. py:attribute:: DeembeddingTypeAttrVals.VECTOR - The trigger is received on PXI trigger line 6. + De-embeds the measurement using the gain term and the reflection term. - .. py:attribute:: ConfigListTrigDigEdgeSource.PXI_TRIG7 +DigModType +---------- + +.. py:class:: DigModType + + .. py:attribute:: DigModType.NONE - The trigger is received on PXI trigger line 7. + Disables digital modulation. - .. py:attribute:: ConfigListTrigDigEdgeSource.PXI_STAR + .. py:attribute:: DigModType.FSK - The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646. + Specifies that the digital modulation type is frequency-shift keying (FSK). - .. py:attribute:: ConfigListTrigDigEdgeSource.PXIE_DSTARB + .. py:attribute:: DigModType.OOK - The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5840/5841/5842. + Specifies that the digital modulation type is on-off keying (OOK). - .. py:attribute:: ConfigListTrigDigEdgeSource.MARKER0_EVENT + .. py:attribute:: DigModType.PSK - The trigger is received from the Marker Event 0. + Specifies that the digital modulation type is phase-shift keying (PSK). - .. py:attribute:: ConfigListTrigDigEdgeSource.MARKER1_EVENT +DigModWfmType +------------- + +.. py:class:: DigModWfmType + + .. py:attribute:: DigModWfmType.PRBS - The trigger is received from the Marker Event 1. + Specifies that the digital modulation waveform type is pseudorandom bit sequence (PRBS). - .. py:attribute:: ConfigListTrigDigEdgeSource.MARKER2_EVENT + .. py:attribute:: DigModWfmType.USER_DEFINED - The trigger is received from the Marker Event 2. + 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. - .. py:attribute:: ConfigListTrigDigEdgeSource.MARKER3_EVENT +DigitalEqualizationEnabled +-------------------------- + +.. py:class:: DigitalEqualizationEnabled + + .. py:attribute:: DigitalEqualizationEnabled.DISABLE - The trigger is received from the Marker Event 3. + Filter is not applied - .. py:attribute:: ConfigListTrigDigEdgeSource.TIMER_EVENT + .. py:attribute:: DigitalEqualizationEnabled.ENABLE - The trigger is received from the Timer Event. + Filter is applied. - .. py:attribute:: ConfigListTrigDigEdgeSource.TRIG_IN +DirectDownload +-------------- + +.. py:class:: DirectDownload + + .. py:attribute:: DirectDownload.DISABLE - The trigger is received on the TRIG IN/OUT terminal. This value is valid on only the PXIe-5654/5654 with PXIe-5696. + The RF In local oscillator signal is not present at the front panel LO OUT connector. - .. py:attribute:: ConfigListTrigDigEdgeSource.DIO0 + .. py:attribute:: DirectDownload.ENABLE - The trigger is received on PFI0 from the front panel DIO terminal. + The RF In local oscillator signal is present at the front panel LO OUT connector. - .. py:attribute:: ConfigListTrigDigEdgeSource.DIO1 + .. py:attribute:: DirectDownload.UNSPECIFIED - The trigger is received on PFI1 from the front panel DIO terminal. + The RF IN local oscillator signal may or may not be present at the front panel LO OUT connector, because NI-RFSA may be controlling it. - .. py:attribute:: ConfigListTrigDigEdgeSource.DIO2 +FilterType +---------- + +.. py:class:: FilterType + + .. py:attribute:: FilterType.NONE - The trigger is received on PFI2 from the front panel DIO terminal. + No filter type is applied. - .. py:attribute:: ConfigListTrigDigEdgeSource.DIO3 + .. py:attribute:: FilterType.ARB_FILTER_TYPE_ROOT_RAISED_COSINE - The trigger is received on PFI3 from the front panel DIO terminal. + 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:: ConfigListTrigDigEdgeSource.DIO4 + .. py:attribute:: FilterType.ARB_FILTER_TYPE_RAISED_COSINE - The trigger is received on PFI4 from the front panel DIO terminal. + 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:attribute:: ConfigListTrigDigEdgeSource.DIO5 +Format +------ + +.. py:class:: Format + + .. py:attribute:: Format.MAGNITUDE_AND_PHASE - The trigger is received on PFI5 from the front panel DIO terminal. + Results in a linear interpolation of the magnitude and a separate linear interpolation of the phase. - .. py:attribute:: ConfigListTrigDigEdgeSource.DIO6 + .. py:attribute:: Format.MAGNITUDE_DB_AND_PHASE - The trigger is received on PFI6 from the front panel DIO terminal. + Results in a linear interpolation of the magnitude, in decibels, and a separate linear interpolation of the phase. - .. py:attribute:: ConfigListTrigDigEdgeSource.DIO7 + .. py:attribute:: Format.REAL_AND_IMAGINARY - The trigger is received on PFI7 from the front panel DIO terminal. + Results in a linear interpolation of the real portion of the complex number and a separate linear interpolation of the complex portion. -ConfigListTrigExportOutputTerm ------------------------------- +FrequencySettlingUnits +---------------------- -.. py:class:: ConfigListTrigExportOutputTerm +.. py:class:: FrequencySettlingUnits - .. py:attribute:: ConfigListTrigExportOutputTerm.DO_NOT_EXPORT + .. py:attribute:: FrequencySettlingUnits.TIME_AFTER_LOCK - The signal is not exported. + Specifies the time to wait after the frequency PLL locks. - .. py:attribute:: ConfigListTrigExportOutputTerm.PFI0 + .. py:attribute:: FrequencySettlingUnits.TIME_AFTER_IO - The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. + Specifies the time to wait after all writes occur to change the frequency - .. py:attribute:: ConfigListTrigExportOutputTerm.PFI1 + .. py:attribute:: FrequencySettlingUnits.PPM - The signal is exported on PFI 1 connector. + Specifies the minimum frequency accuracy when settling completes. Units are in parts per million (PPM or 1E-6). - .. py:attribute:: ConfigListTrigExportOutputTerm.PXI_TRIG0 +GenerationMode +-------------- + +.. py:class:: GenerationMode + + .. py:attribute:: GenerationMode.CW - The signal is exported to the PXI trigger line 0. . + Configures the RF signal generator to generate a CW signal. - .. py:attribute:: ConfigListTrigExportOutputTerm.PXI_TRIG1 + .. py:attribute:: GenerationMode.ARB_WAVEFORM - The signal is exported to the PXI trigger line 0. + Configures the RF signal generator to generate the arbitrary waveform specified by the :py:attr:`nirfsg.Session.arb_selected_waveform` property. - .. py:attribute:: ConfigListTrigExportOutputTerm.PXI_TRIG2 + .. py:attribute:: GenerationMode.SCRIPT - The signal is exported to the PXI trigger line 2. + Configures the RF signal generator to generate arbitrary waveforms as directed by the :py:attr:`nirfsg.Session.selected_script` property. - .. py:attribute:: ConfigListTrigExportOutputTerm.PXI_TRIG3 +IQOutPortTermCfg +---------------- + +.. py:class:: IQOutPortTermCfg + + .. py:attribute:: IQOutPortTermCfg.DIFFERENTIAL - The signal is exported to the PXI trigger line 3. + Sets the terminal configuration to differential. - .. py:attribute:: ConfigListTrigExportOutputTerm.PXI_TRIG4 + .. py:attribute:: IQOutPortTermCfg.SINGLE_ENDED - The signal is exported to the PXI trigger line 4. + Sets the terminal configuration to single-ended. - .. py:attribute:: ConfigListTrigExportOutputTerm.PXI_TRIG5 +Lo1OutputFilter +--------------- +.. py:class:: Lo1OutputFilter + .. py:attribute:: Lo1OutputFilter.MANUAL - The signal is exported to the PXI trigger line 5. - + yet to be defined + - .. py:attribute:: ConfigListTrigExportOutputTerm.PXI_TRIG6 + .. py:attribute:: Lo1OutputFilter.SCRIPT_TRIGGER - The signal is exported to the PXI trigger line 6. - + yet to be defined + - .. py:attribute:: ConfigListTrigExportOutputTerm.PXIE_DSTARC +LoOutEnabled +------------ - The trigger is received on the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5840/5841/5842. +.. py:class:: LoOutEnabled - + .. py:attribute:: LoOutEnabled.DISABLE - .. py:attribute:: ConfigListTrigExportOutputTerm.TRIG_OUT + The local oscillator signal is present at the LO OUT front panel connector. + - The trigger is received on the TRIG IN/OUT terminal. This value is valid on only the PXIe-5654/5654 with PXIe-5696. - + .. py:attribute:: LoOutEnabled.MANUAL - .. py:attribute:: ConfigListTrigExportOutputTerm.DIO0 + .. py:attribute:: LoOutEnabled.ENABLE - The trigger is received on PFI0 from the front panel DIO terminal. + The local oscillator signal is not present at the LO OUT front panel connector.. - .. py:attribute:: ConfigListTrigExportOutputTerm.DIO1 - - + .. py:attribute:: LoOutEnabled.SCRIPT_TRIGGER - The trigger is received on PFI1 from the front panel DIO terminal. - +LoOutExportConfigureFromRFSaEnable +---------------------------------- +.. py:class:: LoOutExportConfigureFromRFSaEnable - .. py:attribute:: ConfigListTrigExportOutputTerm.DIO2 + .. py:attribute:: LoOutExportConfigureFromRFSaEnable.DISABLE - The trigger is received on PFI2 from the front panel DIO terminal. + Do not allow NI-RFSA to control the NI-RFSG local oscillator export. - .. py:attribute:: ConfigListTrigExportOutputTerm.DIO3 + .. py:attribute:: LoOutExportConfigureFromRFSaEnable.MANUAL + + .. py:attribute:: LoOutExportConfigureFromRFSaEnable.ENABLE - The trigger is received on PFI3 from the front panel DIO terminal. - + Allow NI-RFSA to control the NI-RFSG local oscillator export. + - .. py:attribute:: ConfigListTrigExportOutputTerm.DIO4 + .. py:attribute:: LoOutExportConfigureFromRFSaEnable.SCRIPT_TRIGGER - The trigger is received on PFI4 from the front panel DIO terminal. - +LoPlLfractionalModeEnabled +-------------------------- +.. py:class:: LoPlLfractionalModeEnabled - .. py:attribute:: ConfigListTrigExportOutputTerm.DIO5 + .. py:attribute:: LoPlLfractionalModeEnabled.DISABLE - The trigger is received on PFI5 from the front panel DIO terminal. + Disables fractional mode for the LO PLL. - .. py:attribute:: ConfigListTrigExportOutputTerm.DIO6 - + .. py:attribute:: LoPlLfractionalModeEnabled.MANUAL - The trigger is received on PFI6 from the front panel DIO terminal. - + .. py:attribute:: LoPlLfractionalModeEnabled.ENABLE - .. py:attribute:: ConfigListTrigExportOutputTerm.DIO7 + Enables fractional mode for the LO PLL. + - The trigger is received on PFI7 from the front panel DIO terminal. - + .. py:attribute:: LoPlLfractionalModeEnabled.SCRIPT_TRIGGER -ConfigListTrigType ------------------- +LoadOptions +----------- -.. py:class:: ConfigListTrigType +.. py:class:: LoadOptions - .. py:attribute:: ConfigListTrigType.NONE + .. py:attribute:: LoadOptions.NONE - Generation starts immediately, but the list does not advance. + NI-RFSG loads all the configurations to the session. - .. py:attribute:: ConfigListTrigType.DIGITAL_EDGE + .. py:attribute:: LoadOptions.WAVEFORMS - Data operation does not start until a digital edge is detected. The source of the digital edge is specified in the %property{digital edge configuration list step trigger source} property, and the active edge is always rising. + NI-RFSG skips loading the waveform configurations to the session. -ConfigurationListRepeat ------------------------ +LoopBandwidth +------------- -.. py:class:: ConfigurationListRepeat +.. py:class:: LoopBandwidth - .. py:attribute:: ConfigurationListRepeat.CONFIGURATION_LIST_REPEAT_CONTINUOUS + .. py:attribute:: LoopBandwidth.NARROW - NI-RFSG runs the configuration list continuously. + Uses the narrowest loop bandwidth setting for the PLL. - .. py:attribute:: ConfigurationListRepeat.MANUAL + .. py:attribute:: LoopBandwidth.MEDIUM - .. py:attribute:: ConfigurationListRepeat.CONFIGURATION_LIST_REPEAT_SINGLE + Uses the medium loop bandwidth setting for the PLL. + - NI-RFSG runs the configuration list only once. - + .. py:attribute:: LoopBandwidth.WIDE - .. py:attribute:: ConfigurationListRepeat.SCRIPT_TRIGGER + Uses the widest loop bandwidth setting for the PLL. + + -ConfigurationSettledEventExportOutputTerm ------------------------------------------ +MarkerEventOutputBehavior +------------------------- -.. py:class:: ConfigurationSettledEventExportOutputTerm +.. py:class:: MarkerEventOutputBehavior - .. py:attribute:: ConfigurationSettledEventExportOutputTerm.DO_NOT_EXPORT + .. py:attribute:: MarkerEventOutputBehavior.PULSE - The signal is not exported. + Specifies the Marker Event output behavior as pulse. - .. py:attribute:: ConfigurationSettledEventExportOutputTerm.PXI_TRIG0 + .. py:attribute:: MarkerEventOutputBehavior.TOGGLE - PXI trigger line 0. + Specifies the Marker Event output behavior as toggle. - .. py:attribute:: ConfigurationSettledEventExportOutputTerm.PXI_TRIG1 +MarkerEventPulseWidthUnits +-------------------------- + +.. py:class:: MarkerEventPulseWidthUnits + + .. py:attribute:: MarkerEventPulseWidthUnits.SECONDS - PXI trigger line 1. + Specifies the Marker Event pulse width units as seconds. - .. py:attribute:: ConfigurationSettledEventExportOutputTerm.PXI_TRIG2 + .. py:attribute:: MarkerEventPulseWidthUnits.SAMPLE_CLOCK_PERIODS - PXI trigger line 2. + Specifies the Marker Event pulse width units as Sample Clock periods. - .. py:attribute:: ConfigurationSettledEventExportOutputTerm.PXI_TRIG3 +MarkerEventToggleInitialState +----------------------------- + +.. py:class:: MarkerEventToggleInitialState + + .. py:attribute:: MarkerEventToggleInitialState.LOW - PXI trigger line 3. + Specifies the initial state of the Marker Event toggle behavior as digital low. - .. py:attribute:: ConfigurationSettledEventExportOutputTerm.PXI_TRIG4 + .. py:attribute:: MarkerEventToggleInitialState.HIGH - PXI trigger line 4. + Specifies the initial state of the Marker Event toggle behavior as digital high. - .. py:attribute:: ConfigurationSettledEventExportOutputTerm.PXI_TRIG5 +Module +------ +.. py:class:: Module + .. py:attribute:: Module.AWG - PXI trigger line 5. - + The AWG associated with the primary module. + - .. py:attribute:: ConfigurationSettledEventExportOutputTerm.PXI_TRIG6 - - PXI trigger line 6. - - - - - - .. py:attribute:: ConfigurationSettledEventExportOutputTerm.PXIE_DSTARC - - - - PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842. - - - - - - .. py:attribute:: ConfigurationSettledEventExportOutputTerm.TRIG_OUT + .. py:attribute:: Module.LO - TRIG IN/OUT terminal. + The LO associated with the primary module. -DeembeddingTypeAttrVals ------------------------ - -.. py:class:: DeembeddingTypeAttrVals - - .. py:attribute:: DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_NONE + .. py:attribute:: Module.PRIMARY_MODULE - De-embedding is not applied to the measurement. + The stand-alone device or the main module in a multi-module device. - .. py:attribute:: DeembeddingTypeAttrVals.NONE - +OffsetUnits +----------- +.. py:class:: OffsetUnits - .. py:attribute:: DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_SCALAR + .. py:attribute:: OffsetUnits.PERCENT - De-embeds the measurement using only the gain term. + Specifies the unit in percentage. - .. py:attribute:: DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_VECTOR + .. py:attribute:: OffsetUnits.VOLTS - De-embeds the measurement using the gain term and the reflection term. + Specifies the unit in volts. -DigModType +OutputPort ---------- -.. py:class:: DigModType - - .. py:attribute:: DigModType.NONE - - - - Disables digital modulation. - - - - - - .. py:attribute:: DigModType.FSK - - - - Specifies that the digital modulation type is frequency-shift keying (FSK). - - - - - - .. py:attribute:: DigModType.OOK - - - - Specifies that the digital modulation type is on-off keying (OOK). - - - - - - .. py:attribute:: DigModType.PSK - - - - Specifies that the digital modulation type is phase-shift keying (PSK). - - - - - -DigModWfmType -------------- - -.. py:class:: DigModWfmType - - .. py:attribute:: DigModWfmType.PRBS - - - - Specifies that the digital modulation waveform type is pseudorandom bit sequence (PRBS). - - - - - - .. py:attribute:: DigModWfmType.USER_DEFINED - - - - Specifies that the digital modulation waveform type is user defined. To specify the user-defined waveform, call the %method{configure digital modulation user defined waveform} method. - - - - - -DigitalEqualizationEnabled --------------------------- - -.. py:class:: DigitalEqualizationEnabled - - .. py:attribute:: DigitalEqualizationEnabled.DISABLE - - - - Filter is not applied - - - - - - .. py:attribute:: DigitalEqualizationEnabled.ENABLE - - - - Filter is applied. - - - - - -DirectDownload --------------- - -.. py:class:: DirectDownload - - .. py:attribute:: DirectDownload.DISABLE - - - - The RF In local oscillator signal is not present at the front panel LO OUT connector. - - - - - - .. py:attribute:: DirectDownload.ENABLE - - - - The RF In local oscillator signal is present at the front panel LO OUT connector. - - - - - - .. py:attribute:: DirectDownload.UNSPECIFIED - - - - The RF IN local oscillator signal may or may not be present at the front panel LO OUT connector, because NI-RFSA may be controlling it. - - - - - -DoneEventExportOutputTerm -------------------------- - -.. py:class:: DoneEventExportOutputTerm - - .. py:attribute:: DoneEventExportOutputTerm.DO_NOT_EXPORT - - - - The signal is not exported. - - - - - - .. py:attribute:: DoneEventExportOutputTerm.PFI0 - - - - The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. - - - - - - .. py:attribute:: DoneEventExportOutputTerm.PFI1 - - - - The signal is exported to the PFI 1 connector. - - - - - - .. py:attribute:: DoneEventExportOutputTerm.PFI4 - - - - The signal is exported to the PFI 4 connector. - - - - - - .. py:attribute:: DoneEventExportOutputTerm.PFI5 - - - - The signal is exported to the PFI 5 connector. - - - - +.. py:class:: OutputPort - .. py:attribute:: DoneEventExportOutputTerm.PXI_TRIG0 + .. py:attribute:: OutputPort.RF_OUT - The signal is exported to the PXI trigger line 0. + Enables the RF OUT port. This value is not valid for the PXIe-5820. - .. py:attribute:: DoneEventExportOutputTerm.PXI_TRIG1 + .. py:attribute:: OutputPort.IQ_OUT - The signal is exported to the PXI trigger line 1. + Enables the I/Q OUT port. This value is valid on only the PXIe-5645 and PXIe-5820. - .. py:attribute:: DoneEventExportOutputTerm.PXI_TRIG2 + .. py:attribute:: OutputPort.CAL_OUT - The signal is exported to the PXI trigger line 2. + Enables the CAL OUT port. - .. py:attribute:: DoneEventExportOutputTerm.PXI_TRIG3 + .. py:attribute:: OutputPort.I_ONLY - The signal is exported to the PXI trigger line 3. + Enables the I connectors of the I/Q OUT port. This value is valid on only the PXIe-5645. - .. py:attribute:: DoneEventExportOutputTerm.PXI_TRIG4 - - - - The signal is exported to the PXI trigger line 4. - - - +OverflowErrorReporting +---------------------- +.. py:class:: OverflowErrorReporting - .. py:attribute:: DoneEventExportOutputTerm.PXI_TRIG5 + .. py:attribute:: OverflowErrorReporting.WARNING - The signal is exported to the PXI trigger line 5. + NI-RFSG returns a warning when an OSP overflow occurs. - .. py:attribute:: DoneEventExportOutputTerm.PXI_TRIG6 + .. py:attribute:: OverflowErrorReporting.DISABLED - The signal is exported to the PXI trigger line 6. + NI-RFSG does not return an error or a warning when an OSP overflow occurs. - .. py:attribute:: DoneEventExportOutputTerm.PXIE_DSTARC - - - - The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841. - - - +PhaseContinuityEnabled +---------------------- +.. py:class:: PhaseContinuityEnabled - .. py:attribute:: DoneEventExportOutputTerm.DIO0 + .. py:attribute:: PhaseContinuityEnabled.AUTO - The trigger is received on PFI0 from the front panel DIO terminal. + The arbitrary waveform may be repeated to ensure phase continuity after upconversion. This setting could cause waveform size to increase. - .. py:attribute:: DoneEventExportOutputTerm.DIO1 + .. py:attribute:: PhaseContinuityEnabled.DISABLE - The trigger is received on PFI1 from the front panel DIO terminal. + The arbitrary waveform plays back without regard to any possible phase discontinuities introduced by upconversion. The time duration of the original waveform is maintained. - .. py:attribute:: DoneEventExportOutputTerm.DIO2 + .. py:attribute:: PhaseContinuityEnabled.ENABLE - The trigger is received on PFI2 from the front panel DIO terminal. + The arbitrary waveform may be repeated to ensure phase continuity after upconversion. Enabling this property could cause waveform size to increase. - .. py:attribute:: DoneEventExportOutputTerm.DIO3 - - - - The trigger is received on PFI3 from the front panel DIO terminal. - - - +PortTypes +--------- +.. py:class:: PortTypes - .. py:attribute:: DoneEventExportOutputTerm.DIO4 + .. py:attribute:: PortTypes.OUT - The trigger is received on PFI4 from the front panel DIO terminal. + Specifies the PXIe-5840 RF OUT port. - .. py:attribute:: DoneEventExportOutputTerm.DIO5 + .. py:attribute:: PortTypes.IN - The trigger is received on PFI5 from the front panel DIO terminal. + Specifies the PXIe-5840 RF IN port. This value is not supported as the first element of an array. - .. py:attribute:: DoneEventExportOutputTerm.DIO6 - - - - The trigger is received on PFI6 from the front panel DIO terminal. - - - - - - .. py:attribute:: DoneEventExportOutputTerm.DIO7 - - - - The trigger is received on PFI7 from the front panel DIO terminal. - - - - - -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 %property{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 %property{arb filter raised cosine alpha} property. - - - - - -Format ------- - -.. py:class:: Format - - .. py:attribute:: Format.MAGNITUDE_AND_PHASE - - - - Results in a linear interpolation of the magnitude and a separate linear interpolation of the phase. - - - - - - .. py:attribute:: Format.MAGNITUDE_DB_AND_PHASE - - - - Results in a linear interpolation of the magnitude, in decibels, and a separate linear interpolation of the phase. - - - - - - .. py:attribute:: Format.REAL_AND_IMAGINARY - - - - Results in a linear interpolation of the real portion of the complex number and a separate linear interpolation of the complex portion. - - - - - -FrequencySettlingUnits ----------------------- - -.. py:class:: FrequencySettlingUnits - - .. py:attribute:: FrequencySettlingUnits.TIME_AFTER_LOCK - - - - Specifies the time to wait after the frequency PLL locks. - - - - - - .. py:attribute:: FrequencySettlingUnits.TIME_AFTER_IO - - - - Specifies the time to wait after all writes occur to change the frequency - - - - - - .. py:attribute:: FrequencySettlingUnits.PPM - - - - Specifies the minimum frequency accuracy when settling completes. Units are in parts per million (PPM or 1E-6). - - - - - -GenerationMode +PowerLevelType -------------- -.. py:class:: GenerationMode - - .. py:attribute:: GenerationMode.CW - - - - Configures the RF signal generator to generate a CW signal. - - - - - - .. py:attribute:: GenerationMode.ARB_WAVEFORM - - - - Configures the RF signal generator to generate the arbitrary waveform specified by the %property{arb selected waveform} property. - - - - - - .. py:attribute:: GenerationMode.SCRIPT - - - - Configures the RF signal generator to generate arbitrary waveforms as directed by the %property{selected script} property. - - - - - -IQOutPortTermCfg ----------------- - -.. py:class:: IQOutPortTermCfg - - .. py:attribute:: IQOutPortTermCfg.DIFFERENTIAL - - - - Sets the terminal configuration to differential. - - - - - - .. py:attribute:: IQOutPortTermCfg.SINGLE_ENDED - - - - Sets the terminal configuration to single-ended. - - - - - -Lo1OutputFilter ---------------- - -.. py:class:: Lo1OutputFilter - - .. py:attribute:: Lo1OutputFilter.MANUAL - - - - yet to be defined - - - - - - .. py:attribute:: Lo1OutputFilter.SCRIPT_TRIGGER - - - - yet to be defined - - - - - -LoOutEnabled ------------- - -.. py:class:: LoOutEnabled - - .. py:attribute:: LoOutEnabled.DISABLE - - - - The local oscillator signal is present at the LO OUT front panel connector. - - - - - - .. py:attribute:: LoOutEnabled.MANUAL - - - - .. py:attribute:: LoOutEnabled.ENABLE - - - - The local oscillator signal is not present at the LO OUT front panel connector.. - - - - - - .. py:attribute:: LoOutEnabled.SCRIPT_TRIGGER - - - -LoOutExportConfigureFromRFSaEnable ----------------------------------- - -.. py:class:: LoOutExportConfigureFromRFSaEnable - - .. py:attribute:: LoOutExportConfigureFromRFSaEnable.DISABLE - - - - Do not allow NI-RFSA to control the NI-RFSG local oscillator export. - - - - - - .. py:attribute:: LoOutExportConfigureFromRFSaEnable.MANUAL - - - - .. py:attribute:: LoOutExportConfigureFromRFSaEnable.ENABLE - - - - Allow NI-RFSA to control the NI-RFSG local oscillator export. - - - - - - .. py:attribute:: LoOutExportConfigureFromRFSaEnable.SCRIPT_TRIGGER - - - -LoPlLfractionalModeEnabled --------------------------- - -.. py:class:: LoPlLfractionalModeEnabled - - .. py:attribute:: LoPlLfractionalModeEnabled.DISABLE - - - - Disables fractional mode for the LO PLL. - - - - - - .. py:attribute:: LoPlLfractionalModeEnabled.MANUAL - - - - .. py:attribute:: LoPlLfractionalModeEnabled.ENABLE - - - - Enables fractional mode for the LO PLL. - - - - - - .. py:attribute:: LoPlLfractionalModeEnabled.SCRIPT_TRIGGER - - - -LoSource --------- - -.. py:class:: LoSource - - .. py:attribute:: LoSource.ONBOARD - - - - Uses an internal LO as the LO source. If you specify an internal LO source, the LO is generated inside the device itself. - - - - - - .. py:attribute:: LoSource.LO_IN - - - - Uses an external LO as the LO source. Connect a signal to the LO IN connector on the device and use the %property{upconverter center frequency} property to specify the LO frequency. - - - - - - .. py:attribute:: LoSource.SECONDARY - - - - Uses the PXIe-5831/5840 internal LO as the LO source. This value is valid only on the PXIe-5831 with PXIe-5653 and PXIe-5832 with PXIe-5653. - - - - - - .. py:attribute:: LoSource.SG_SA_SHARED - - - - Uses the same internal LO during NI-RFSA and NI-RFSG sessions. NI-RFSG selects an internal synthesizer and the synthesizer signal is switched to both the RF In and RF Out mixers. This value is valid only on the PXIe-5830/5831/5832/5841 with PXIe-5655/5842. - - - - - - .. py:attribute:: LoSource.AUTOMATIC_SG_SA_SHARED - - - - NI-RFSG internally makes the configuration to share the LO between NI-RFSA and NI-RFSG. This value is valid only on the PXIe-5820/5830/5831/5832/5840/5841/5842. - - - - - -LoadOptions ------------ - -.. py:class:: LoadOptions - - .. py:attribute:: LoadOptions.RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_LOAD_OPTIONS_SKIP_NONE - - - - NI-RFSG loads all the configurations to the session. - - - - - - .. py:attribute:: LoadOptions.MANUAL - - - - .. py:attribute:: LoadOptions.RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_LOAD_OPTIONS_SKIP_WAVEFORM - - - - NI-RFSG skips loading the waveform configurations to the session. - - - - - - .. py:attribute:: LoadOptions.SCRIPT_TRIGGER - - - -LoopBandwidth -------------- - -.. py:class:: LoopBandwidth - - .. py:attribute:: LoopBandwidth.NARROW - - - - Uses the narrowest loop bandwidth setting for the PLL. - - - - - - .. py:attribute:: LoopBandwidth.MEDIUM - - - - Uses the medium loop bandwidth setting for the PLL. - - - - - - .. py:attribute:: LoopBandwidth.WIDE - - - - Uses the widest loop bandwidth setting for the PLL. - - - - - -MarkerEventExportOutputTerm ---------------------------- - -.. py:class:: MarkerEventExportOutputTerm - - .. py:attribute:: MarkerEventExportOutputTerm.DO_NOT_EXPORT - - - - The signal is not exported. - - - - - - .. py:attribute:: MarkerEventExportOutputTerm.PFI0 - - - - The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. - - - - - - .. py:attribute:: MarkerEventExportOutputTerm.PFI1 - - - - The signal is exported to the PFI 1 connector. - - - - - - .. py:attribute:: MarkerEventExportOutputTerm.PFI4 - - - - The signal is exported to the PFI 4 connector. - - - - - - .. py:attribute:: MarkerEventExportOutputTerm.PFI5 - - - - The signal is exported to the PFI 5 connector. - - - - - - .. py:attribute:: MarkerEventExportOutputTerm.PXI_TRIG0 - - - - The signal is exported to PXI trigger line 0. - - - - - - .. py:attribute:: MarkerEventExportOutputTerm.PXI_TRIG1 - - - - The signal is exported to PXI trigger line 1. - - - - - - .. py:attribute:: MarkerEventExportOutputTerm.PXI_TRIG2 - - - - The signal is exported to PXI trigger line 2. - - - - - - .. py:attribute:: MarkerEventExportOutputTerm.PXI_TRIG3 - - - - The signal is exported to PXI trigger line 3. - - - - - - .. py:attribute:: MarkerEventExportOutputTerm.PXI_TRIG4 - - - - The signal is exported to PXI trigger line 4. - - - - - - .. py:attribute:: MarkerEventExportOutputTerm.PXI_TRIG5 - - - - The signal is exported to PXI trigger line 5. - - - - - - .. py:attribute:: MarkerEventExportOutputTerm.PXI_TRIG6 - - - - The signal is exported to PXI trigger line 6. - - - - - - .. py:attribute:: MarkerEventExportOutputTerm.PXIE_DSTARC - - - - The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841. - - - - - - .. py:attribute:: MarkerEventExportOutputTerm.DIO0 - - - - The trigger is received on PFI0 from the front panel DIO terminal. - - - - - - .. py:attribute:: MarkerEventExportOutputTerm.DIO1 - - - - The trigger is received on PFI1 from the front panel DIO terminal. - - - - - - .. py:attribute:: MarkerEventExportOutputTerm.DIO2 - - - - The trigger is received on PFI2 from the front panel DIO terminal. - - - - - - .. py:attribute:: MarkerEventExportOutputTerm.DIO3 - - - - The trigger is received on PFI3 from the front panel DIO terminal. - - - - - - .. py:attribute:: MarkerEventExportOutputTerm.DIO4 - - - - The trigger is received on PFI4 from the front panel DIO terminal. - - - - - - .. py:attribute:: MarkerEventExportOutputTerm.DIO5 - - - - The trigger is received on PFI5 from the front panel DIO terminal. - - - - - - .. py:attribute:: MarkerEventExportOutputTerm.DIO6 - - - - The trigger is received on PFI6 from the front panel DIO terminal. - - - - - - .. py:attribute:: MarkerEventExportOutputTerm.DIO7 - - - - The trigger is received on PFI7 from the front panel DIO terminal. - - - - - -MarkerEventOutputBehavior -------------------------- - -.. py:class:: MarkerEventOutputBehavior - - .. py:attribute:: MarkerEventOutputBehavior.PULSE - - - - Specifies the Marker Event output behavior as pulse. - - - - - - .. py:attribute:: MarkerEventOutputBehavior.TOGGLE - - - - Specifies the Marker Event output behavior as toggle. - - - - - -MarkerEventPulseWidthUnits --------------------------- - -.. py:class:: MarkerEventPulseWidthUnits - - .. py:attribute:: MarkerEventPulseWidthUnits.SECONDS - - - - Specifies the Marker Event pulse width units as seconds. - - - - - - .. py:attribute:: MarkerEventPulseWidthUnits.SAMPLE_CLOCK_PERIODS - - - - Specifies the Marker Event pulse width units as Sample Clock periods. - - - - - -MarkerEventToggleInitialState ------------------------------ - -.. py:class:: MarkerEventToggleInitialState - - .. py:attribute:: MarkerEventToggleInitialState.LOW - - - - Specifies the initial state of the Marker Event toggle behavior as digital low. - - - - - - .. py:attribute:: MarkerEventToggleInitialState.HIGH - - - - Specifies the initial state of the Marker Event toggle behavior as digital high. - - - - - -Module ------- - -.. py:class:: Module - - .. py:attribute:: Module.AWG - - - - The AWG associated with the primary module. - - - - - - .. py:attribute:: Module.LO - - - - The LO associated with the primary module. - - - - - - .. py:attribute:: Module.PRIMARY_MODULE - - - - The stand-alone device or the main module in a multi-module device. - - - - - -OffsetUnits ------------ - -.. py:class:: OffsetUnits - - .. py:attribute:: OffsetUnits.PERCENT - - - - Specifies the unit in percentage. - - - - - - .. py:attribute:: OffsetUnits.VOLTS - - - - Specifies the unit in volts. - - - - - -OutputPort ----------- - -.. py:class:: OutputPort - - .. py:attribute:: OutputPort.RF_OUT - - - - Enables the RF OUT port. This value is not valid for the PXIe-5820. - - - - - - .. py:attribute:: OutputPort.IQ_OUT - - - - Enables the I/Q OUT port. This value is valid on only the PXIe-5645 and PXIe-5820. - - - - - - .. py:attribute:: OutputPort.CAL_OUT - - - - Enables the CAL OUT port. - - - - - - .. py:attribute:: OutputPort.I_ONLY - - - - Enables the I connectors of the I/Q OUT port. This value is valid on only the PXIe-5645. - - - - - -OverflowErrorReporting ----------------------- - -.. py:class:: OverflowErrorReporting - - .. py:attribute:: OverflowErrorReporting.WARNING - - - - NI-RFSG returns a warning when an OSP overflow occurs. - - - - - - .. py:attribute:: OverflowErrorReporting.DISABLED - - - - NI-RFSG does not return an error or a warning when an OSP overflow occurs. - - - - - -PhaseContinuityEnabled ----------------------- - -.. py:class:: PhaseContinuityEnabled - - .. py:attribute:: PhaseContinuityEnabled.AUTO - - - - The arbitrary waveform may be repeated to ensure phase continuity after upconversion. This setting could cause waveform size to increase. - - - - - - .. py:attribute:: PhaseContinuityEnabled.DISABLE - - - - The arbitrary waveform plays back without regard to any possible phase discontinuities introduced by upconversion. The time duration of the original waveform is maintained. - - - - - - .. py:attribute:: PhaseContinuityEnabled.ENABLE - - - - The arbitrary waveform may be repeated to ensure phase continuity after upconversion. Enabling this property could cause waveform size to increase. - - - - - -PortTypes ---------- - -.. py:class:: PortTypes - - .. py:attribute:: PortTypes.OUT - - - - Specifies the PXIe-5840 RF OUT port. - - - - - - .. py:attribute:: PortTypes.IN - - - - Specifies the PXIe-5840 RF IN port. This value is not supported as the first element of an array. - - - - - -PowerLevelType --------------- - -.. py:class:: PowerLevelType - - .. py:attribute:: PowerLevelType.AVERAGE - - - - Indicates the desired power averaged in time. The driver maximizes the dynamic range by scaling the I/Q waveform so that its peak magnitude is equal to one. If your write more than one waveform, NI-RFSG scales each waveform without preserving the power level ratio between the waveforms. This value is not valid for the PXIe-5820. - - - - - - .. py:attribute:: PowerLevelType.PEAK - - - - Indicates the maximum power level of the RF signal averaged over one period of the RF carrier frequency (the peak envelope power). This setting requires that the magnitude of the I/Q waveform must always be less than or equal to one. When using peak power, the power level of the RF signal matches the specified power level at moments when the magnitude of the I/Q waveform equals one. If you write more than one waveform, the relative scaling between waveforms is preserved. In peak power mode, waveforms are scaled according to the %property{arb waveform software scaling factor} property. You can use the %property{peak power adjustment} property in conjunction with the %property{power level} property when the %property{power level type} property is set to %enum_value{power level type.peak power}. - - - - - -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 -------------------- - -.. py:class:: PulseModulationMode - - .. py:attribute:: PulseModulationMode.OPTIMAL_MATCH - - - - Provides for a more optimal power output match for the device during the off cycle of the pulse mode operation. Not supported on PXIe-5842 - - - - - - .. py:attribute:: PulseModulationMode.HIGH_ISOLATION - - - - Allows for the best on/off power ratio of the pulsed signal. - - - - - - .. py:attribute:: PulseModulationMode.ANALOG - - - - Analog switch blanking. Balance between switching speed and on/off power ratio of the pulsed signal. - - - - - - .. py:attribute:: PulseModulationMode.DIGITAL - - - - Digital only modulation. Provides the best on/off switching speed of the pulsed signal at the cost of signal isolation. - - - - - -PulseModulationOutputTerm -------------------------- - -.. py:class:: PulseModulationOutputTerm - - .. py:attribute:: PulseModulationOutputTerm.DO_NOT_EXPORT - - - - Pulse modulation video signal is not exported. - - - - - - .. py:attribute:: PulseModulationOutputTerm.PULSE_OUT - - - - Export the pulse modulation video signal on the pulse out terminal. - - - - - -PulseModulationSource ---------------------- - -.. py:class:: PulseModulationSource - - .. py:attribute:: PulseModulationSource.PULSE_IN - - - - The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842. - - - - - - .. py:attribute:: PulseModulationSource.MARKER0 - - - - The trigger is received from the Marker 0. - - - - - - .. py:attribute:: PulseModulationSource.MARKER1 - - - - The trigger is received from the Marker 1. - - - - - - .. py:attribute:: PulseModulationSource.MARKER2 - - - - The trigger is received from the Marker 2. - - - - - - .. py:attribute:: PulseModulationSource.MARKER3 - - - - The trigger is received from the Marker 3. - - - - - -PxiChassisClk10Source ---------------------- - -.. py:class:: PxiChassisClk10Source - - .. py:attribute:: PxiChassisClk10Source.NONE - - - - Do not drive the PXI_CLK10 signal. - - - - - - .. py:attribute:: PxiChassisClk10Source.DO_NOT_EXPORT_STR - - - - .. py:attribute:: PxiChassisClk10Source.ONBOARD_CLOCK_STR - - - - Uses the highly stable oven-controlled onboard Reference Clock to drive the PXI_CLK signal. - - - - - - .. py:attribute:: PxiChassisClk10Source.REF_IN_STR - - - - Uses the clock present at the front panel REF IN connector to drive the PXI_CLK signal. - - - - - -RFBlanking ----------- - -.. py:class:: RFBlanking - - .. py:attribute:: RFBlanking.DISABLE - - - - RF blanking is disabled. - - - - - - .. py:attribute:: RFBlanking.ENABLE - - - - RF blanking is enabled. - - - - - -RFFilter --------- - -.. py:class:: RFFilter - - .. py:attribute:: RFFilter.HI_FREQ_MOD - - - - yet to be defined - - - - - - .. py:attribute:: RFFilter.CONFIGURATION_SETTLED_EVENT - - - - .. py:attribute:: RFFilter.LO_FREQ_MOD_4000 - - - - yet to be defined - - - - - - .. py:attribute:: RFFilter.LO_FREQ_MOD_2500 - - - - yet to be defined - - - - - -RFInLoExportEnabled -------------------- - -.. py:class:: RFInLoExportEnabled - - .. py:attribute:: RFInLoExportEnabled.UNSPECIFIED - - - - The RF IN local oscillator signal may or may not be present at the front panel LO OUT connector, because NI-RFSA may - - - - - - .. py:attribute:: RFInLoExportEnabled.DISABLE - - - - The RF In local oscillator signal is not present at the front panel LO OUT connector. - - - - - - .. py:attribute:: RFInLoExportEnabled.MANUAL - - - - .. py:attribute:: RFInLoExportEnabled.ENABLE - - - - The RF In local oscillator signal is present at the front panel LO OUT connector. - - - - - - .. py:attribute:: RFInLoExportEnabled.SCRIPT_TRIGGER - - - -ReferenceClockExportOutputTerminal ----------------------------------- - -.. py:class:: ReferenceClockExportOutputTerminal - - .. py:attribute:: ReferenceClockExportOutputTerminal.DO_NOT_EXPORT - - - - The Reference Clock signal is not exported. - - - - - - .. py:attribute:: ReferenceClockExportOutputTerminal.REF_OUT - - - - Exports the Reference Clock signal to the REF OUT connector of the device. - - - - - - .. py:attribute:: ReferenceClockExportOutputTerminal.REF_OUT2 - - - - Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable. - - - - - - .. py:attribute:: ReferenceClockExportOutputTerminal.CLK_OUT - - - - Exports the Reference Clock signal to the CLK OUT connector of the device. - - - - - -ReferenceClockExportedRate --------------------------- - -.. py:class:: ReferenceClockExportedRate - - .. py:attribute:: ReferenceClockExportedRate._10mhz - - - - Uses a 10MHz Reference Clock rate. - - - - - - .. py:attribute:: ReferenceClockExportedRate._100mhz - - - - Uses a 100MHz Reference Clock rate. - - - - - - .. py:attribute:: ReferenceClockExportedRate._1ghz - - - - Uses a 1GHz Reference Clock rate. - - - - - -ReferenceClockRate ------------------- - -.. py:class:: ReferenceClockRate - - .. py:attribute:: ReferenceClockRate.AUTO - - - - Uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if the device supports it. - - - - - - .. py:attribute:: ReferenceClockRate._10mhz - - - - Uses a 10MHz Reference Clock rate. - - - - - -ReferenceClockSource --------------------- - -.. py:class:: ReferenceClockSource - - .. py:attribute:: ReferenceClockSource.ONBOARD_CLOCK - - - - Uses the onboard Reference Clock as the clock source. - - - - - - .. py:attribute:: ReferenceClockSource.REF_IN - - - - Uses the clock signal present at the front panel REF IN connector as the Reference Clock source. - - - - - - .. py:attribute:: ReferenceClockSource.PXI_CLK - - - - Uses the PXI_CLK signal, which is present on the PXI backplane, as the Reference Clock source. - - - - - - .. py:attribute:: ReferenceClockSource.CLK_IN - - - - Uses the clock signal present at the front panel CLK IN connector as the Reference Clock source. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5831 with PXIe-5653/5832/5832 with PXIe-5653/5840/5841/5841 with PXIe-5655. - - - - - - .. py:attribute:: ReferenceClockSource.REF_IN_2 - - - - This value is not valid on any supported devices. - - - - - - .. py:attribute:: ReferenceClockSource.PXI_CLK_MASTER - - - - This value is valid on only the PXIe-5831/5832 with PXIe-5653. **PXIe-5831/5832 with PXIe-5653 —** NI-RFSG configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3622 to use :py:data:`~nirfsg.ReferenceClockSource.PXI_CLK` %enum_value as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector. - - - - - -RelativeTo ----------- - -.. py:class:: RelativeTo - - .. py:attribute:: RelativeTo.CURRENT_POSITION - - - - The reference position is relative to the current position. - - - - - - .. py:attribute:: RelativeTo.START_OF_WAVEFORM - - - - The reference position is relative to the start of the waveform. - - - - - -ResetOptions ------------- - -.. py:class:: ResetOptions - - .. py:attribute:: ResetOptions.RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_WAVEFORMS - - - - NI-RFSG skips resetting the waveform configurations. - - - - - - .. py:attribute:: ResetOptions.MANUAL - - - - .. py:attribute:: ResetOptions.RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_DEEMBEDDING_TABLES - - - - NI-RFSG skips resetting the de-embedding tables. - - - - - - .. py:attribute:: ResetOptions.SCRIPT_TRIGGER - - - - .. py:attribute:: ResetOptions.RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_SCRIPTS - - - - NI-RFSG skips resetting the scripts. - - - - - - .. py:attribute:: ResetOptions.MARKER_EVENT - - - - .. py:attribute:: ResetOptions.RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_NONE - - - - NI-RFSG resets all configurations. - - - - - - .. py:attribute:: ResetOptions.SELF_CAL_IMAGE_SUPPRESSION - - - -ResetWithOptionsStepsToOmit ---------------------------- - -.. py:class:: ResetWithOptionsStepsToOmit - - .. py:attribute:: ResetWithOptionsStepsToOmit.DEEMBEDDING_TABLES - - - - Omits deleting de-embedding tables. This step is valid only for the PXIe-5830/5831/5832/5840. - - - - - - .. py:attribute:: ResetWithOptionsStepsToOmit.NONE - - - - No step is omitted during reset. - - - - - - .. py:attribute:: ResetWithOptionsStepsToOmit.ROUTES - - - - Omits the routing reset step. Routing is preserved after a reset. However, routing related properties are reset to default, and routing is released if the default properties are committed after a reset. - - - - - - .. py:attribute:: ResetWithOptionsStepsToOmit.SCRIPTS - - - - Omits clearing scripts. - - - - - - .. py:attribute:: ResetWithOptionsStepsToOmit.WAVEFORMS - - - - Omits clearing waveforms. - - - - - -ScriptTrigDigEdgeEdge ---------------------- - -.. py:class:: ScriptTrigDigEdgeEdge - - .. py:attribute:: ScriptTrigDigEdgeEdge.RISING - - - - Asserts the trigger when the signal transitions from low level to high level. - - - - - - .. py:attribute:: ScriptTrigDigEdgeEdge.FALLING - - - - Asserts the trigger when the signal transitions from high level to low level. - - - - - -ScriptTrigDigEdgeSource ------------------------ - -.. py:class:: ScriptTrigDigEdgeSource - - .. py:attribute:: ScriptTrigDigEdgeSource.PFI0 - - - - The trigger is received on PFI 0. - - - - - - .. py:attribute:: ScriptTrigDigEdgeSource.PFI1 - - - - The trigger is received on PFI 1. - - - - - - .. py:attribute:: ScriptTrigDigEdgeSource.PFI2 - - - - The trigger is received on PFI 2. - - - - - - .. py:attribute:: ScriptTrigDigEdgeSource.PFI3 - - - - The trigger is received on PFI 3. - - - - - - .. py:attribute:: ScriptTrigDigEdgeSource.PXI_TRIG0 - - - - The trigger is received on PXI trigger line 0. - - - - - - .. py:attribute:: ScriptTrigDigEdgeSource.PXI_TRIG1 - - - - The trigger is received on PXI trigger line 1. - - - - - - .. py:attribute:: ScriptTrigDigEdgeSource.PXI_TRIG2 - - - - The trigger is received on PXI trigger line 2. - - - - - - .. py:attribute:: ScriptTrigDigEdgeSource.PXI_TRIG3 - - - - The trigger is received on PXI trigger line 3. - - - - - - .. py:attribute:: ScriptTrigDigEdgeSource.PXI_TRIG4 - - - - The trigger is received on PXI trigger line 4. - - - - - - .. py:attribute:: ScriptTrigDigEdgeSource.PXI_TRIG5 - - - - The trigger is received on PXI trigger line 5. - - - - - - .. py:attribute:: ScriptTrigDigEdgeSource.PXI_TRIG6 - - - - The trigger is received on PXI trigger line 6. - - - - - - .. py:attribute:: ScriptTrigDigEdgeSource.PXI_TRIG7 - - - - The trigger is received on PXI trigger line 7. - - - - - - .. py:attribute:: ScriptTrigDigEdgeSource.PXI_STAR - - - - The trigger is received on the PXI star trigger line. This value is not valid on the PXIe-5644/5645/5646. - - - - - - .. py:attribute:: ScriptTrigDigEdgeSource.PXIE_DSTARB - - - - The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/ - - - - - - .. py:attribute:: ScriptTrigDigEdgeSource.PULSE_IN - - - - The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842. - - - - - - .. py:attribute:: ScriptTrigDigEdgeSource.DIO0 - - - - The trigger is received on PFI0 from the front panel DIO terminal. - - - - - - .. py:attribute:: ScriptTrigDigEdgeSource.DIO1 - - - - The trigger is received on PFI1 from the front panel DIO terminal. - - - - - - .. py:attribute:: ScriptTrigDigEdgeSource.DIO2 - - - - The trigger is received on PFI2 from the front panel DIO terminal. - - - - - - .. py:attribute:: ScriptTrigDigEdgeSource.DIO3 - - - - The trigger is received on PFI3 from the front panel DIO terminal. - - - - - - .. py:attribute:: ScriptTrigDigEdgeSource.DIO4 - - - - The trigger is received on PFI4 from the front panel DIO terminal. - - - - - - .. py:attribute:: ScriptTrigDigEdgeSource.DIO5 - - - - The trigger is received on PFI5 from the front panel DIO terminal. - - - - - - .. py:attribute:: ScriptTrigDigEdgeSource.DIO6 - - - - The trigger is received on PFI6 from the front panel DIO terminal. - - - - - - .. py:attribute:: ScriptTrigDigEdgeSource.DIO7 - - - - The trigger is received on PFI7 from the front panel DIO terminal. - - - - - - .. py:attribute:: ScriptTrigDigEdgeSource.SYNC_SCRIPT_TRIGGER - - - - The trigger is received on the Sync Script trigger line. This value is valid on only the PXIe-5644/5645/5646. - - - - - -ScriptTrigDigLevelActiveLevel ------------------------------ - -.. py:class:: ScriptTrigDigLevelActiveLevel - - .. py:attribute:: ScriptTrigDigLevelActiveLevel.HIGH - - - - Trigger when the digital trigger signal is high. - - - - - - .. py:attribute:: ScriptTrigDigLevelActiveLevel.LOW - - - - Trigger when the digital trigger signal is low. - - - - - -ScriptTrigDigLevelSource ------------------------- - -.. py:class:: ScriptTrigDigLevelSource - - .. py:attribute:: ScriptTrigDigLevelSource.PFI0 - - - - The trigger is received on PFI 0. - - - - - - .. py:attribute:: ScriptTrigDigLevelSource.PFI1 - - - - The trigger is received on PFI 1. - - - - - - .. py:attribute:: ScriptTrigDigLevelSource.PFI2 - - - - The trigger is received on PFI 2. - - - - - - .. py:attribute:: ScriptTrigDigLevelSource.PFI3 - - - - The trigger is received on PFI 3. - - - - - - .. py:attribute:: ScriptTrigDigLevelSource.PXI_TRIG0 - - - - The trigger is received on PXI trigger line 0. - - - - - - .. py:attribute:: ScriptTrigDigLevelSource.PXI_TRIG1 - - - - The trigger is received on PXI trigger line 1. - - - - - - .. py:attribute:: ScriptTrigDigLevelSource.PXI_TRIG2 - - - - The trigger is received on PXI trigger line 2. - - - - - - .. py:attribute:: ScriptTrigDigLevelSource.PXI_TRIG3 - - - - The trigger is received on PXI trigger line 3. - - - - - - .. py:attribute:: ScriptTrigDigLevelSource.PXI_TRIG4 - - - - The trigger is received on PXI trigger line 4. - - - - - - .. py:attribute:: ScriptTrigDigLevelSource.PXI_TRIG5 - - - - The trigger is received on PXI trigger line 5. - - - - - - .. py:attribute:: ScriptTrigDigLevelSource.PXI_TRIG6 - - - - The trigger is received on PXI trigger line 6. - - - - - - .. py:attribute:: ScriptTrigDigLevelSource.PXI_TRIG7 - - - - The trigger is received on PXI trigger line 7. - - - - - - .. py:attribute:: ScriptTrigDigLevelSource.PXI_STAR - - - - The trigger is received on the PXI star trigger line. This value is not valid on the PXIe-5644/5645/5646. - - - - - - .. py:attribute:: ScriptTrigDigLevelSource.PXIE_DSTARB - - - - The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/ - - - - - - .. py:attribute:: ScriptTrigDigLevelSource.PULSE_IN - - - - The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842. - - - - - - .. py:attribute:: ScriptTrigDigLevelSource.DIO0 - - - - The trigger is received on PFI0 from the front panel DIO terminal. - - - - - - .. py:attribute:: ScriptTrigDigLevelSource.DIO1 - - - - The trigger is received on PFI1 from the front panel DIO terminal. - - - - - - .. py:attribute:: ScriptTrigDigLevelSource.DIO2 - - - - The trigger is received on PFI2 from the front panel DIO terminal. - - - - - - .. py:attribute:: ScriptTrigDigLevelSource.DIO3 - - - - The trigger is received on PFI3 from the front panel DIO terminal. - - - - - - .. py:attribute:: ScriptTrigDigLevelSource.DIO4 - - - - The trigger is received on PFI4 from the front panel DIO terminal. - - - - - - .. py:attribute:: ScriptTrigDigLevelSource.DIO5 - - - - The trigger is received on PFI5 from the front panel DIO terminal. - - - - - - .. py:attribute:: ScriptTrigDigLevelSource.DIO6 - - - - The trigger is received on PFI6 from the front panel DIO terminal. - - - - - - .. py:attribute:: ScriptTrigDigLevelSource.DIO7 - - - - The trigger is received on PFI7 from the front panel DIO terminal. - - - - - -ScriptTrigExportOutputTerm --------------------------- - -.. py:class:: ScriptTrigExportOutputTerm - - .. py:attribute:: ScriptTrigExportOutputTerm.DO_NOT_EXPORT - - - - The signal is not exported. - - - - - - .. py:attribute:: ScriptTrigExportOutputTerm.PFI0 - - - - The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. - - - - - - .. py:attribute:: ScriptTrigExportOutputTerm.PFI1 - - - - The signal is exported to the PFI 1 connector. - - - - - - .. py:attribute:: ScriptTrigExportOutputTerm.PFI4 - - - - The signal is exported to the PFI 4 connector. - - - - - - .. py:attribute:: ScriptTrigExportOutputTerm.PFI5 - - - - The signal is exported to the PFI 5 connector. - - - - - - .. py:attribute:: ScriptTrigExportOutputTerm.PXI_TRIG0 - - - - The signal is exported to the PXI trigger line 0. - - - - - - .. py:attribute:: ScriptTrigExportOutputTerm.PXI_TRIG1 - - - - The signal is exported to the PXI trigger line 1. - - - - - - .. py:attribute:: ScriptTrigExportOutputTerm.PXI_TRIG2 - - - - The signal is exported to the PXI trigger line 2. - - - - - - .. py:attribute:: ScriptTrigExportOutputTerm.PXI_TRIG3 - - - - The signal is exported to the PXI trigger line 3. - - - - - - .. py:attribute:: ScriptTrigExportOutputTerm.PXI_TRIG4 - - - - The signal is exported to the PXI trigger line 4. - - - - - - .. py:attribute:: ScriptTrigExportOutputTerm.PXI_TRIG5 - - - - The signal is exported to the PXI trigger line 5. - - - - - - .. py:attribute:: ScriptTrigExportOutputTerm.PXI_TRIG6 - - - - The signal is exported to the PXI trigger line 6. - - - - - - .. py:attribute:: ScriptTrigExportOutputTerm.PXIE_DSTARC - - - - The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/ - - - - - - .. py:attribute:: ScriptTrigExportOutputTerm.DIO0 - - - - The trigger is received on PFI0 from the front panel DIO terminal. - - - - - - .. py:attribute:: ScriptTrigExportOutputTerm.DIO1 - - - - The trigger is received on PFI1 from the front panel DIO terminal. - - - - - - .. py:attribute:: ScriptTrigExportOutputTerm.DIO2 - - - - The trigger is received on PFI2 from the front panel DIO terminal. - - - - - - .. py:attribute:: ScriptTrigExportOutputTerm.DIO3 - - - - The trigger is received on PFI3 from the front panel DIO terminal. - - - - - - .. py:attribute:: ScriptTrigExportOutputTerm.DIO4 - - - - The trigger is received on PFI4 from the front panel DIO terminal. - - - - - - .. py:attribute:: ScriptTrigExportOutputTerm.DIO5 - - - - The trigger is received on PFI5 from the front panel DIO terminal. - - - - - - .. py:attribute:: ScriptTrigExportOutputTerm.DIO6 - - - - The trigger is received on PFI6 from the front panel DIO terminal. - - - - - - .. py:attribute:: ScriptTrigExportOutputTerm.DIO7 - - - - The trigger is received on PFI7 from the front panel DIO terminal. - - - - - -ScriptTrigType --------------- - -.. py:class:: ScriptTrigType - - .. py:attribute:: ScriptTrigType.NONE - - - - No trigger is configured. Signal generation starts immediately. - - - - - - .. py:attribute:: ScriptTrigType.DIGITAL_EDGE - - - - The data operation does not start until a digital edge is detected. The source of the digital edge is specified with the %property{digital edge start trigger source} property, and the active edge is specified with the %property{digital edge start trigger edge} property. - - - - - - .. py:attribute:: ScriptTrigType.DIGITAL_LEVEL - - - - The data operation does not start until the digital level is detected. The source of the digital level is specified in the %property{digital level script trigger source} property, and the active level is specified in the %property{digital level script trigger active level} property. - - - - - - .. py:attribute:: ScriptTrigType.SOFTWARE - - - - The data operation does not start until a software trigger occurs. You can create a software event by calling the %method{send software edge trigger} method. - - - - - -SelfCalibrateRangeStepsToOmit ------------------------------ - -.. py:class:: SelfCalibrateRangeStepsToOmit - - .. py:attribute:: SelfCalibrateRangeStepsToOmit.IMAGE_SUPPRESSION - - - - Omits the Image Suppression step. If you omit this step, the Residual Sideband Image performance is not adjusted. - - - - - - .. py:attribute:: SelfCalibrateRangeStepsToOmit.LO_SELF_CAL - - - - Omits the LO Self Cal step. If you omit this step, the power level of the LO is not adjusted. - - - - - - .. py:attribute:: SelfCalibrateRangeStepsToOmit.OMIT_NONE - - - - No calibration steps are omitted. - - - - - - .. py:attribute:: SelfCalibrateRangeStepsToOmit.POWER_LEVEL_ACCURACY - - - - Omits the Power Level Accuracy step. If you omit this step, the power level accuracy of the device is not adjusted. - - - - - - .. py:attribute:: SelfCalibrateRangeStepsToOmit.RESIDUAL_LO_POWER - - - - Omits the Residual LO Power step. If you omit this step, the Residual LO Power performance is not adjusted. - - - - - - .. py:attribute:: SelfCalibrateRangeStepsToOmit.SYNTHESIZER_ALIGNMENT - - - - Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted. - - - - - -Signal ------- - -.. py:class:: Signal - - .. py:attribute:: Signal.CONFIGURATION_SETTLED_EVENT - - - - Exports a Configuration Settled Event. - - - - - - .. py:attribute:: Signal.START_TRIGGER - - - - Exports a Start Trigger. - - - - - - .. py:attribute:: Signal.SCRIPT_TRIGGER - - - - Exports a Script Trigger. - - - - - - .. py:attribute:: Signal.MARKER_EVENT - - - - Exports a Marker Event. - - - - - - .. py:attribute:: Signal.REF_CLOCK - - - - Exports the Reference Clock. - - - - - - .. py:attribute:: Signal.STARTED_EVENT - - - - Exports a Started Event. - - - - - - .. py:attribute:: Signal.DONE_EVENT - - - - Exports a Done Event. - - - - - - .. py:attribute:: Signal.CONFIGURATION_LIST_STEP_TRIGGER - - - - Exports a Configuration List Step Trigger. - - - - - -SignalIdentifier ----------------- - -.. py:class:: SignalIdentifier - - .. py:attribute:: SignalIdentifier.MARKER_EVENT0 - - - - Specifies Marker 0. - - - - - - .. py:attribute:: SignalIdentifier.MARKER_EVENT1 - - - - Specifies Marker 1. - - - - - - .. py:attribute:: SignalIdentifier.MARKER_EVENT2 - - - - Specifies Marker 2. - - - - - - .. py:attribute:: SignalIdentifier.MARKER_EVENT3 - - - - Specifies Marker 3. - - - - - - .. py:attribute:: SignalIdentifier.SCRIPT_TRIGGER0 - - - - Specifies Script Trigger 0. - - - - - - .. py:attribute:: SignalIdentifier.SCRIPT_TRIGGER1 - - - - Specifies Script Trigger 1. - - - - - - .. py:attribute:: SignalIdentifier.SCRIPT_TRIGGER2 - - - - Specifies Script Trigger 2. - - - - - - .. py:attribute:: SignalIdentifier.SCRIPT_TRIGGER3 - - - - Specifies Script Trigger 3. - - - - - -SoftwareTriggerType -------------------- - -.. py:class:: SoftwareTriggerType - - .. py:attribute:: SoftwareTriggerType.SCRIPT - - - - Specifies the Script Trigger. - - - - - - .. py:attribute:: SoftwareTriggerType.START - - - - Specifies the Start Trigger. - - - - - -SparameterOrientation ---------------------- - -.. py:class:: SparameterOrientation - - .. py:attribute:: SparameterOrientation.PORT1 - - - - Port 1 of the S2P is oriented towards the DUT port. - - - - - - .. py:attribute:: SparameterOrientation.PORT2 - - - - Port 2 of the S2P is oriented towards the DUT port. - - - - - -StartTrigDigEdgeEdge --------------------- - -.. py:class:: StartTrigDigEdgeEdge - - .. py:attribute:: StartTrigDigEdgeEdge.RISING - - - - Occurs when the signal transitions from low level to high level. - - - - - - .. py:attribute:: StartTrigDigEdgeEdge.FALLING - - - - Occurs when the signal transitions from high level to low level. - - - - - -StartTrigDigEdgeSource ----------------------- - -.. py:class:: StartTrigDigEdgeSource - - .. py:attribute:: StartTrigDigEdgeSource.PFI0 - - - - The trigger is received on PFI 0. - - - - - - .. py:attribute:: StartTrigDigEdgeSource.PFI1 - - - - The trigger is received on PFI 1. - - - - - - .. py:attribute:: StartTrigDigEdgeSource.PFI2 - - - - The trigger is received on PFI 2. - - - - - - .. py:attribute:: StartTrigDigEdgeSource.PFI3 - - - - The trigger is received on PFI 3. - - - - - - .. py:attribute:: StartTrigDigEdgeSource.PXI_TRIG0 - - - - The trigger is received on PXI trigger line 0. - - - - +.. py:class:: PowerLevelType - .. py:attribute:: StartTrigDigEdgeSource.PXI_TRIG1 + .. py:attribute:: PowerLevelType.AVERAGE - The trigger is received on PXI trigger line 1. + Indicates the desired power averaged in time. The driver maximizes the dynamic range by scaling the I/Q waveform so that its peak magnitude is equal to one. If your write more than one waveform, NI-RFSG scales each waveform without preserving the power level ratio between the waveforms. This value is not valid for the PXIe-5820. - .. py:attribute:: StartTrigDigEdgeSource.PXI_TRIG2 + .. py:attribute:: PowerLevelType.PEAK - The trigger is received on PXI trigger line 2. + Indicates the maximum power level of the RF signal averaged over one period of the RF carrier frequency (the peak envelope power). This setting requires that the magnitude of the I/Q waveform must always be less than or equal to one. When using peak power, the power level of the RF signal matches the specified power level at moments when the magnitude of the I/Q waveform equals one. If you write more than one waveform, the relative scaling between waveforms is preserved. In peak power mode, waveforms are scaled according to the :py:attr:`nirfsg.Session.arb_waveform_software_scaling_factor` property. You can use the :py:attr:`nirfsg.Session.peak_power_adjustment` property in conjunction with the :py:attr:`nirfsg.Session.power_level` property when the :py:attr:`nirfsg.Session.power_level_type` property is set to :py:data:`~nirfsg.PowerLevelType.PEAK`. - .. py:attribute:: StartTrigDigEdgeSource.PXI_TRIG3 +PpaInheritance +-------------- + +.. py:class:: PpaInheritance + + .. py:attribute:: PpaInheritance.EXACT_MATCH - The trigger is received on PXI trigger line 3. + Errors out if different values are detected in the script. - .. py:attribute:: StartTrigDigEdgeSource.PXI_TRIG4 + .. py:attribute:: PpaInheritance.MINIMUM - The trigger is received on PXI trigger line 4. + Uses the minimum value found in the script. - .. py:attribute:: StartTrigDigEdgeSource.PXI_TRIG5 + .. py:attribute:: PpaInheritance.MAXIMUM - The trigger is received on PXI trigger line 5. + Uses the maximum value found in the script. - .. py:attribute:: StartTrigDigEdgeSource.PXI_TRIG6 +PulseModulationMode +------------------- + +.. py:class:: PulseModulationMode + + .. py:attribute:: PulseModulationMode.OPTIMAL_MATCH - The trigger is received on PXI trigger line 6. + Provides for a more optimal power output match for the device during the off cycle of the pulse mode operation. Not supported on PXIe-5842 - .. py:attribute:: StartTrigDigEdgeSource.PXI_TRIG7 + .. py:attribute:: PulseModulationMode.HIGH_ISOLATION - The trigger is received on PXI trigger line 7. + Allows for the best on/off power ratio of the pulsed signal. - .. py:attribute:: StartTrigDigEdgeSource.PXI_STAR + .. py:attribute:: PulseModulationMode.ANALOG - The trigger is received on the PXI star trigger line. This value is not valid on the PXIe-5644/5645/5646. + Analog switch blanking. Balance between switching speed and on/off power ratio of the pulsed signal. - .. py:attribute:: StartTrigDigEdgeSource.PXIE_DSTARB + .. py:attribute:: PulseModulationMode.DIGITAL - The trigger is received on the PXI DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. + Digital only modulation. Provides the best on/off switching speed of the pulsed signal at the cost of signal isolation. - .. py:attribute:: StartTrigDigEdgeSource.TRIG_IN +RFBlanking +---------- + +.. py:class:: RFBlanking + + .. py:attribute:: RFBlanking.DISABLE - The trigger is received on the TRIG IN/OUT terminal. This value is valid on only the PXIe-5654/5654 with PXIe-5696. + RF blanking is disabled. - .. py:attribute:: StartTrigDigEdgeSource.DIO0 + .. py:attribute:: RFBlanking.ENABLE - The trigger is received on PFI0 from the front panel DIO terminal. + RF blanking is enabled. - .. py:attribute:: StartTrigDigEdgeSource.DIO1 - - +RFFilter +-------- - The trigger is received on PFI1 from the front panel DIO terminal. +.. py:class:: RFFilter - + .. py:attribute:: RFFilter.HI_FREQ_MOD - .. py:attribute:: StartTrigDigEdgeSource.DIO2 + yet to be defined + - The trigger is received on PFI2 from the front panel DIO terminal. - + .. py:attribute:: RFFilter.CONFIGURATION_SETTLED_EVENT - .. py:attribute:: StartTrigDigEdgeSource.DIO3 + .. py:attribute:: RFFilter.LO_FREQ_MOD_4000 - The trigger is received on PFI3 from the front panel DIO terminal. + yet to be defined - .. py:attribute:: StartTrigDigEdgeSource.DIO4 + .. py:attribute:: RFFilter.LO_FREQ_MOD_2500 - The trigger is received on PFI4 from the front panel DIO terminal. + yet to be defined - .. py:attribute:: StartTrigDigEdgeSource.DIO5 +RFInLoExportEnabled +------------------- + +.. py:class:: RFInLoExportEnabled + + .. py:attribute:: RFInLoExportEnabled.UNSPECIFIED - The trigger is received on PFI5 from the front panel DIO terminal. + The RF IN local oscillator signal may or may not be present at the front panel LO OUT connector, because NI-RFSA may - .. py:attribute:: StartTrigDigEdgeSource.DIO6 + .. py:attribute:: RFInLoExportEnabled.DISABLE - The trigger is received on PFI6 from the front panel DIO terminal. + The RF In local oscillator signal is not present at the front panel LO OUT connector. - .. py:attribute:: StartTrigDigEdgeSource.DIO7 - + .. py:attribute:: RFInLoExportEnabled.MANUAL - The trigger is received on PFI7 from the front panel DIO terminal. - + .. py:attribute:: RFInLoExportEnabled.ENABLE - .. py:attribute:: StartTrigDigEdgeSource.SYNC_START_TRIGGER + The RF In local oscillator signal is present at the front panel LO OUT connector. + - The trigger is received on the Sync Start trigger line. This value is valid on only the PXIe-5644/5645/5646. - + .. py:attribute:: RFInLoExportEnabled.SCRIPT_TRIGGER -StartTrigExportOutputTerm -------------------------- +ReferenceClockExportedRate +-------------------------- -.. py:class:: StartTrigExportOutputTerm +.. py:class:: ReferenceClockExportedRate - .. py:attribute:: StartTrigExportOutputTerm.DO_NOT_EXPORT + .. py:attribute:: ReferenceClockExportedRate._10mhz - The signal is not exported. + Uses a 10MHz Reference Clock rate. - .. py:attribute:: StartTrigExportOutputTerm.PFI0 + .. py:attribute:: ReferenceClockExportedRate._100mhz - The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. + Uses a 100MHz Reference Clock rate. - .. py:attribute:: StartTrigExportOutputTerm.PFI1 + .. py:attribute:: ReferenceClockExportedRate._1ghz - The signal is exported to the PFI 1 connector. + Uses a 1GHz Reference Clock rate. - .. py:attribute:: StartTrigExportOutputTerm.PFI4 +ReferenceClockRate +------------------ + +.. py:class:: ReferenceClockRate + + .. py:attribute:: ReferenceClockRate.AUTO - The signal is exported to the PFI 4 connector. + Uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if the device supports it. - .. py:attribute:: StartTrigExportOutputTerm.PFI5 + .. py:attribute:: ReferenceClockRate._10mhz - The signal is exported to the PFI 5 connector. + Uses a 10MHz Reference Clock rate. - .. py:attribute:: StartTrigExportOutputTerm.PXI_TRIG0 +RelativeTo +---------- + +.. py:class:: RelativeTo + + .. py:attribute:: RelativeTo.CURRENT_POSITION - The signal is exported to the PXI trigger line 0. + The reference position is relative to the current position. - .. py:attribute:: StartTrigExportOutputTerm.PXI_TRIG1 + .. py:attribute:: RelativeTo.START_OF_WAVEFORM - The signal is exported to the PXI trigger line 1. + The reference position is relative to the start of the waveform. - .. py:attribute:: StartTrigExportOutputTerm.PXI_TRIG2 +ResetOptions +------------ + +.. py:class:: ResetOptions + .. py:attribute:: ResetOptions.RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_WAVEFORMS - The signal is exported to the PXI trigger line 2. - + NI-RFSG skips resetting the waveform configurations. + - .. py:attribute:: StartTrigExportOutputTerm.PXI_TRIG3 + .. py:attribute:: ResetOptions.MANUAL - The signal is exported to the PXI trigger line 3. - + .. py:attribute:: ResetOptions.RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_DEEMBEDDING_TABLES - .. py:attribute:: StartTrigExportOutputTerm.PXI_TRIG4 + NI-RFSG skips resetting the de-embedding tables. + - The signal is exported to the PXI trigger line 4. - + .. py:attribute:: ResetOptions.SCRIPT_TRIGGER - .. py:attribute:: StartTrigExportOutputTerm.PXI_TRIG5 + .. py:attribute:: ResetOptions.RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_SCRIPTS - The signal is exported to the PXI trigger line 5. + NI-RFSG skips resetting the scripts. - .. py:attribute:: StartTrigExportOutputTerm.PXI_TRIG6 + .. py:attribute:: ResetOptions.MARKER_EVENT + + .. py:attribute:: ResetOptions.RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_NONE - The signal is exported to the PXI trigger line 6. - + NI-RFSG resets all configurations. + - .. py:attribute:: StartTrigExportOutputTerm.PXIE_DSTARC + .. py:attribute:: ResetOptions.SELF_CAL_IMAGE_SUPPRESSION - The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. - +ResetWithOptionsStepsToOmit +--------------------------- +.. py:class:: ResetWithOptionsStepsToOmit - .. py:attribute:: StartTrigExportOutputTerm.TRIG_OUT + .. py:attribute:: ResetWithOptionsStepsToOmit.DEEMBEDDING_TABLES - The signal is exported to the TRIG IN/OUT terminal. This value is valid on only the PXIe-5654/5654 with PXIe-5696. + Omits deleting de-embedding tables. This step is valid only for the PXIe-5830/5831/5832/5840. - .. py:attribute:: StartTrigExportOutputTerm.DIO0 + .. py:attribute:: ResetWithOptionsStepsToOmit.NONE - The trigger is received on PFI0 from the front panel DIO terminal. + No step is omitted during reset. - .. py:attribute:: StartTrigExportOutputTerm.DIO1 + .. py:attribute:: ResetWithOptionsStepsToOmit.ROUTES - The trigger is received on PFI1 from the front panel DIO terminal. + Omits the routing reset step. Routing is preserved after a reset. However, routing related properties are reset to default, and routing is released if the default properties are committed after a reset. - .. py:attribute:: StartTrigExportOutputTerm.DIO2 + .. py:attribute:: ResetWithOptionsStepsToOmit.SCRIPTS - The trigger is received on PFI2 from the front panel DIO terminal. + Omits clearing scripts. - .. py:attribute:: StartTrigExportOutputTerm.DIO3 + .. py:attribute:: ResetWithOptionsStepsToOmit.WAVEFORMS - The trigger is received on PFI3 from the front panel DIO terminal. + Omits clearing waveforms. - .. py:attribute:: StartTrigExportOutputTerm.DIO4 +ScriptTrigDigEdgeEdge +--------------------- + +.. py:class:: ScriptTrigDigEdgeEdge + + .. py:attribute:: ScriptTrigDigEdgeEdge.RISING - The trigger is received on PFI4 from the front panel DIO terminal. + Asserts the trigger when the signal transitions from low level to high level. - .. py:attribute:: StartTrigExportOutputTerm.DIO5 + .. py:attribute:: ScriptTrigDigEdgeEdge.FALLING - The trigger is received on PFI5 from the front panel DIO terminal. + Asserts the trigger when the signal transitions from high level to low level. - .. py:attribute:: StartTrigExportOutputTerm.DIO6 +ScriptTrigDigLevelActiveLevel +----------------------------- + +.. py:class:: ScriptTrigDigLevelActiveLevel + + .. py:attribute:: ScriptTrigDigLevelActiveLevel.HIGH - The trigger is received on PFI6 from the front panel DIO terminal. + Trigger when the digital trigger signal is high. - .. py:attribute:: StartTrigExportOutputTerm.DIO7 + .. py:attribute:: ScriptTrigDigLevelActiveLevel.LOW - The trigger is received on PFI7 from the front panel DIO terminal. + Trigger when the digital trigger signal is low. -StartTrigType -------------- +ScriptTrigType +-------------- -.. py:class:: StartTrigType +.. py:class:: ScriptTrigType - .. py:attribute:: StartTrigType.NONE + .. py:attribute:: ScriptTrigType.NONE - No trigger is configured. + No trigger is configured. Signal generation starts immediately. - .. py:attribute:: StartTrigType.DIGITAL_EDGE + .. py:attribute:: ScriptTrigType.DIGITAL_EDGE - The data operation does not start until a digital edge is detected. The source of the digital edge is specified with the %property{digital edge start trigger source} property, and the active edge is specified in the %property{digital edge start trigger edge} property. + The data operation does not start until a digital edge is detected. The source of the digital edge is specified with the :py:attr:`nirfsg.Session.digital_edge_start_trigger_source` property, and the active edge is specified with the :py:attr:`nirfsg.Session.digital_edge_start_trigger_edge` property. - .. py:attribute:: StartTrigType.SOFTWARE + .. py:attribute:: ScriptTrigType.DIGITAL_LEVEL - The data operation does not start until a software event occurs. You may create a software trigger by calling the %method{send software edge trigger} method. + The data operation does not start until the digital level is detected. The source of the digital level is specified in the :py:attr:`nirfsg.Session.digital_level_script_trigger_source` property, and the active level is specified in the :py:attr:`nirfsg.Session.digital_level_script_trigger_active_level` property. - .. py:attribute:: StartTrigType.P2P_ENDPOINT_FULLNESS + .. py:attribute:: ScriptTrigType.SOFTWARE - The data operation does not start until the endpoint reaches the threshold specified in the %property{p2p endpoint fullness start trigger level} property. + The data operation does not start until a software trigger occurs. You can create a software event by calling the :py:meth:`nirfsg.Session.send_software_edge_trigger` method. -StartedEventExportOutputTerm ----------------------------- +SelfCalibrateRangeStepsToOmit +----------------------------- -.. py:class:: StartedEventExportOutputTerm +.. py:class:: SelfCalibrateRangeStepsToOmit - .. py:attribute:: StartedEventExportOutputTerm.DO_NOT_EXPORT + .. py:attribute:: SelfCalibrateRangeStepsToOmit.IMAGE_SUPPRESSION - The signal is not exported. + Omits the Image Suppression step. If you omit this step, the Residual Sideband Image performance is not adjusted. - .. py:attribute:: StartedEventExportOutputTerm.PFI0 + .. py:attribute:: SelfCalibrateRangeStepsToOmit.LO_SELF_CAL - The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. + Omits the LO Self Cal step. If you omit this step, the power level of the LO is not adjusted. - .. py:attribute:: StartedEventExportOutputTerm.PFI1 + .. py:attribute:: SelfCalibrateRangeStepsToOmit.OMIT_NONE - The signal is exported to the PFI 1 connector. + No calibration steps are omitted. - .. py:attribute:: StartedEventExportOutputTerm.PFI4 + .. py:attribute:: SelfCalibrateRangeStepsToOmit.POWER_LEVEL_ACCURACY - The signal is exported to the PFI 4 connector. + Omits the Power Level Accuracy step. If you omit this step, the power level accuracy of the device is not adjusted. - .. py:attribute:: StartedEventExportOutputTerm.PFI5 + .. py:attribute:: SelfCalibrateRangeStepsToOmit.RESIDUAL_LO_POWER - The signal is exported to the PFI 5 connector. + Omits the Residual LO Power step. If you omit this step, the Residual LO Power performance is not adjusted. - .. py:attribute:: StartedEventExportOutputTerm.PXI_TRIG0 + .. py:attribute:: SelfCalibrateRangeStepsToOmit.SYNTHESIZER_ALIGNMENT - The signal is exported to the PXI trigger line 0. + Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted. - .. py:attribute:: StartedEventExportOutputTerm.PXI_TRIG1 - - - - The signal is exported to the PXI trigger line 1. - - - +Signal +------ +.. py:class:: Signal - .. py:attribute:: StartedEventExportOutputTerm.PXI_TRIG2 + .. py:attribute:: Signal.CONFIGURATION_SETTLED_EVENT - The signal is exported to the PXI trigger line 2. + Exports a Configuration Settled Event. - .. py:attribute:: StartedEventExportOutputTerm.PXI_TRIG3 + .. py:attribute:: Signal.START_TRIGGER - The signal is exported to the PXI trigger line 3. + Exports a Start Trigger. - .. py:attribute:: StartedEventExportOutputTerm.PXI_TRIG4 + .. py:attribute:: Signal.SCRIPT_TRIGGER - The signal is exported to the PXI trigger line 4. + Exports a Script Trigger. - .. py:attribute:: StartedEventExportOutputTerm.PXI_TRIG5 + .. py:attribute:: Signal.MARKER_EVENT - The signal is exported to the PXI trigger line 5. + Exports a Marker Event. - .. py:attribute:: StartedEventExportOutputTerm.PXI_TRIG6 + .. py:attribute:: Signal.REF_CLOCK - The signal is exported to the PXI trigger line 6. + Exports the Reference Clock. - .. py:attribute:: StartedEventExportOutputTerm.PXIE_DSTARC + .. py:attribute:: Signal.STARTED_EVENT - The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. + Exports a Started Event. - .. py:attribute:: StartedEventExportOutputTerm.DIO0 + .. py:attribute:: Signal.DONE_EVENT - The trigger is received on PFI0 from the front panel DIO terminal. + Exports a Done Event. - .. py:attribute:: StartedEventExportOutputTerm.DIO1 + .. py:attribute:: Signal.CONFIGURATION_LIST_STEP_TRIGGER - The trigger is received on PFI1 from the front panel DIO terminal. + Exports a Configuration List Step Trigger. - .. py:attribute:: StartedEventExportOutputTerm.DIO2 - - - - The trigger is received on PFI2 from the front panel DIO terminal. - - - +SoftwareTriggerType +------------------- +.. py:class:: SoftwareTriggerType - .. py:attribute:: StartedEventExportOutputTerm.DIO3 + .. py:attribute:: SoftwareTriggerType.SCRIPT - The trigger is received on PFI3 from the front panel DIO terminal. + Specifies the Script Trigger. - .. py:attribute:: StartedEventExportOutputTerm.DIO4 + .. py:attribute:: SoftwareTriggerType.START - The trigger is received on PFI4 from the front panel DIO terminal. + Specifies the Start Trigger. - .. py:attribute:: StartedEventExportOutputTerm.DIO5 +SparameterOrientation +--------------------- + +.. py:class:: SparameterOrientation + + .. py:attribute:: SparameterOrientation.PORT1 - The trigger is received on PFI5 from the front panel DIO terminal. + Port 1 of the S2P is oriented towards the DUT port. - .. py:attribute:: StartedEventExportOutputTerm.DIO6 + .. py:attribute:: SparameterOrientation.PORT2 - The trigger is received on PFI6 from the front panel DIO terminal. + Port 2 of the S2P is oriented towards the DUT port. - .. py:attribute:: StartedEventExportOutputTerm.DIO7 +StartTrigDigEdgeEdge +-------------------- +.. py:class:: StartTrigDigEdgeEdge + .. py:attribute:: StartTrigDigEdgeEdge.RISING - The trigger is received on PFI7 from the front panel DIO terminal. - + Occurs when the signal transitions from low level to high level. + -TriggerIdentifier ------------------ -.. py:class:: TriggerIdentifier - .. py:attribute:: TriggerIdentifier.SCRIPT_TRIGGER0 + .. py:attribute:: StartTrigDigEdgeEdge.FALLING - Specifies Script Trigger 0. + Occurs when the signal transitions from high level to low level. - .. py:attribute:: TriggerIdentifier.SCRIPT_TRIGGER1 +StartTrigType +------------- + +.. py:class:: StartTrigType + + .. py:attribute:: StartTrigType.NONE - Specifies Script Trigger 1. + No trigger is configured. - .. py:attribute:: TriggerIdentifier.SCRIPT_TRIGGER2 + .. py:attribute:: StartTrigType.DIGITAL_EDGE - Specifies Script Trigger 2. + The data operation does not start until a digital edge is detected. The source of the digital edge is specified with the :py:attr:`nirfsg.Session.digital_edge_start_trigger_source` property, and the active edge is specified in the :py:attr:`nirfsg.Session.digital_edge_start_trigger_edge` property. - .. py:attribute:: TriggerIdentifier.SCRIPT_TRIGGER3 + .. py:attribute:: StartTrigType.SOFTWARE - Specifies Script Trigger 3. + The data operation does not start until a software event occurs. You may create a software trigger by calling the :py:meth:`nirfsg.Session.send_software_edge_trigger` method. - .. py:attribute:: TriggerIdentifier.NONE_EMPTY_STRING + .. py:attribute:: StartTrigType.P2P_ENDPOINT_FULLNESS - None (no signal to export) + The data operation does not start until the endpoint reaches the threshold specified in the :py:attr:`nirfsg.Session.p2p_endpoint_fullness_start_trigger_level` property. @@ -4806,35 +1960,27 @@ UpconverterFrequencyOffsetMode - NI-RFSG places the upconverter center frequency outside of the signal bandwidth if the %property{signal bandwidth} property has been set and can be avoided. + NI-RFSG places the upconverter center frequency outside of the signal bandwidth if the :py:attr:`nirfsg.Session.signal_bandwidth` property has been set and can be avoided. - .. py:attribute:: UpconverterFrequencyOffsetMode.AUTOMATIC - - - .. py:attribute:: UpconverterFrequencyOffsetMode.ENABLE - NI-RFSG places the upconverter center frequency outside of the signal bandwidth if the %property{signal bandwidth} property has been set and can be avoided. NI-RFSG returns an error if the %property{signal bandwidth} property has not been set, or if the signal bandwidth is too large. + NI-RFSG places the upconverter center frequency outside of the signal bandwidth if the :py:attr:`nirfsg.Session.signal_bandwidth` property has been set and can be avoided. NI-RFSG returns an error if the :py:attr:`nirfsg.Session.signal_bandwidth` property has not been set, or if the signal bandwidth is too large. - .. py:attribute:: UpconverterFrequencyOffsetMode.SCRIPT_TRIGGER - - - .. py:attribute:: UpconverterFrequencyOffsetMode.USER_DEFINED - NI-RFSG uses the offset that you specified with the %property{upconverter frequency offset} or %property{upconverter center frequency} properties. + NI-RFSG uses the offset that you specified with the :py:attr:`nirfsg.Session.upconverter_frequency_offset` or :py:attr:`nirfsg.Session.upconverter_center_frequency` properties. diff --git a/generated/nirfsg/nirfsg/_library.py b/generated/nirfsg/nirfsg/_library.py index dc194ec70..dcb195225 100644 --- a/generated/nirfsg/nirfsg/_library.py +++ b/generated/nirfsg/nirfsg/_library.py @@ -60,21 +60,22 @@ def __init__(self, ctypes_library): self.niRFSG_DisableScriptTrigger_cfunc = None self.niRFSG_DisableStartTrigger_cfunc = None self.niRFSG_ExportSignal_cfunc = None + self.niRFSG_GetAllNamedWaveformNames_cfunc = None + self.niRFSG_GetAllScriptNames_cfunc = None self.niRFSG_GetAttributeViBoolean_cfunc = None self.niRFSG_GetAttributeViInt32_cfunc = None self.niRFSG_GetAttributeViInt64_cfunc = None self.niRFSG_GetAttributeViReal64_cfunc = None self.niRFSG_GetAttributeViSession_cfunc = None self.niRFSG_GetAttributeViString_cfunc = None + self.niRFSG_GetChannelName_cfunc = None self.niRFSG_GetError_cfunc = None self.niRFSG_GetExternalCalibrationLastDateAndTime_cfunc = None self.niRFSG_GetMaxSettablePower_cfunc = None self.niRFSG_GetSelfCalibrationDateAndTime_cfunc = None self.niRFSG_GetSelfCalibrationTemperature_cfunc = None self.niRFSG_GetStreamEndpointHandle_cfunc = None - self.niRFSG_GetWaveformBurstStartLocations_cfunc = None - self.niRFSG_GetWaveformBurstStopLocations_cfunc = None - self.niRFSG_GetWaveformMarkerEventLocations_cfunc = None + self.niRFSG_GetTerminalName_cfunc = None self.niRFSG_InitWithOptions_cfunc = None self.niRFSG_Initiate_cfunc = None self.niRFSG_LoadConfigurationsFromFile_cfunc = None @@ -87,6 +88,7 @@ def __init__(self, ctypes_library): self.niRFSG_ResetAttribute_cfunc = None self.niRFSG_ResetDevice_cfunc = None self.niRFSG_ResetWithDefaults_cfunc = None + self.niRFSG_ResetWithOptions_cfunc = None self.niRFSG_SaveConfigurationsToFile_cfunc = None self.niRFSG_SelectArbWaveform_cfunc = None self.niRFSG_SelfCal_cfunc = None @@ -100,9 +102,6 @@ def __init__(self, ctypes_library): self.niRFSG_SetAttributeViReal64_cfunc = None self.niRFSG_SetAttributeViSession_cfunc = None self.niRFSG_SetAttributeViString_cfunc = None - self.niRFSG_SetWaveformBurstStartLocations_cfunc = None - self.niRFSG_SetWaveformBurstStopLocations_cfunc = None - self.niRFSG_SetWaveformMarkerEventLocations_cfunc = None self.niRFSG_UnlockSession_cfunc = None self.niRFSG_WaitUntilSettled_cfunc = None self.niRFSG_WriteP2PEndpointI16_cfunc = None @@ -444,6 +443,22 @@ def niRFSG_ExportSignal(self, vi, signal, signal_identifier, output_terminal): self.niRFSG_ExportSignal_cfunc.restype = ViStatus # noqa: F405 return self.niRFSG_ExportSignal_cfunc(vi, signal, signal_identifier, output_terminal) + 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: + self.niRFSG_GetAllNamedWaveformNames_cfunc = self._get_library_function('niRFSG_GetAllNamedWaveformNames') + self.niRFSG_GetAllNamedWaveformNames_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViInt32)] # noqa: F405 + self.niRFSG_GetAllNamedWaveformNames_cfunc.restype = ViStatus # noqa: F405 + return self.niRFSG_GetAllNamedWaveformNames_cfunc(vi, waveform_names, buffer_size, actual_buffer_size) + + def niRFSG_GetAllScriptNames(self, vi, script_names, buffer_size, actual_buffer_size): # noqa: N802 + with self._func_lock: + if self.niRFSG_GetAllScriptNames_cfunc is None: + self.niRFSG_GetAllScriptNames_cfunc = self._get_library_function('niRFSG_GetAllScriptNames') + self.niRFSG_GetAllScriptNames_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViInt32)] # noqa: F405 + self.niRFSG_GetAllScriptNames_cfunc.restype = ViStatus # noqa: F405 + return self.niRFSG_GetAllScriptNames_cfunc(vi, script_names, buffer_size, actual_buffer_size) + def niRFSG_GetAttributeViBoolean(self, vi, channel_name, attribute, value): # noqa: N802 with self._func_lock: if self.niRFSG_GetAttributeViBoolean_cfunc is None: @@ -492,6 +507,14 @@ 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_GetError(self, vi, error_code, error_description_buffer_size, error_description): # noqa: N802 with self._func_lock: if self.niRFSG_GetError_cfunc is None: @@ -540,29 +563,13 @@ def niRFSG_GetStreamEndpointHandle(self, vi, stream_endpoint, reader_handle): # self.niRFSG_GetStreamEndpointHandle_cfunc.restype = ViStatus # noqa: F405 return self.niRFSG_GetStreamEndpointHandle_cfunc(vi, stream_endpoint, reader_handle) - def niRFSG_GetWaveformBurstStartLocations(self, vi, channel_name, number_of_locations, locations, required_size): # noqa: N802 - with self._func_lock: - if self.niRFSG_GetWaveformBurstStartLocations_cfunc is None: - self.niRFSG_GetWaveformBurstStartLocations_cfunc = self._get_library_function('niRFSG_GetWaveformBurstStartLocations') - self.niRFSG_GetWaveformBurstStartLocations_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViReal64), ctypes.POINTER(ViInt32)] # noqa: F405 - self.niRFSG_GetWaveformBurstStartLocations_cfunc.restype = ViStatus # noqa: F405 - return self.niRFSG_GetWaveformBurstStartLocations_cfunc(vi, channel_name, number_of_locations, locations, required_size) - - def niRFSG_GetWaveformBurstStopLocations(self, vi, channel_name, number_of_locations, locations, required_size): # noqa: N802 - with self._func_lock: - if self.niRFSG_GetWaveformBurstStopLocations_cfunc is None: - self.niRFSG_GetWaveformBurstStopLocations_cfunc = self._get_library_function('niRFSG_GetWaveformBurstStopLocations') - self.niRFSG_GetWaveformBurstStopLocations_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViReal64), ctypes.POINTER(ViInt32)] # noqa: F405 - self.niRFSG_GetWaveformBurstStopLocations_cfunc.restype = ViStatus # noqa: F405 - return self.niRFSG_GetWaveformBurstStopLocations_cfunc(vi, channel_name, number_of_locations, locations, required_size) - - def niRFSG_GetWaveformMarkerEventLocations(self, vi, channel_name, number_of_locations, locations, required_size): # noqa: N802 + def niRFSG_GetTerminalName(self, vi, signal, signal_identifier, buffer_size, terminal_name): # noqa: N802 with self._func_lock: - if self.niRFSG_GetWaveformMarkerEventLocations_cfunc is None: - self.niRFSG_GetWaveformMarkerEventLocations_cfunc = self._get_library_function('niRFSG_GetWaveformMarkerEventLocations') - self.niRFSG_GetWaveformMarkerEventLocations_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViReal64), ctypes.POINTER(ViInt32)] # noqa: F405 - self.niRFSG_GetWaveformMarkerEventLocations_cfunc.restype = ViStatus # noqa: F405 - return self.niRFSG_GetWaveformMarkerEventLocations_cfunc(vi, channel_name, number_of_locations, locations, required_size) + if self.niRFSG_GetTerminalName_cfunc is None: + self.niRFSG_GetTerminalName_cfunc = self._get_library_function('niRFSG_GetTerminalName') + self.niRFSG_GetTerminalName_cfunc.argtypes = [ViSession, ViInt32, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViChar)] # noqa: F405 + self.niRFSG_GetTerminalName_cfunc.restype = ViStatus # noqa: F405 + return self.niRFSG_GetTerminalName_cfunc(vi, signal, signal_identifier, buffer_size, terminal_name) def niRFSG_InitWithOptions(self, resource_name, id_query, reset_device, option_string, new_vi): # noqa: N802 with self._func_lock: @@ -660,6 +667,14 @@ def niRFSG_ResetWithDefaults(self, vi): # noqa: N802 self.niRFSG_ResetWithDefaults_cfunc.restype = ViStatus # noqa: F405 return self.niRFSG_ResetWithDefaults_cfunc(vi) + def niRFSG_ResetWithOptions(self, vi, steps_to_omit): # noqa: N802 + with self._func_lock: + if self.niRFSG_ResetWithOptions_cfunc is None: + self.niRFSG_ResetWithOptions_cfunc = self._get_library_function('niRFSG_ResetWithOptions') + self.niRFSG_ResetWithOptions_cfunc.argtypes = [ViSession, ViUInt64] # noqa: F405 + self.niRFSG_ResetWithOptions_cfunc.restype = ViStatus # noqa: F405 + return self.niRFSG_ResetWithOptions_cfunc(vi, steps_to_omit) + def niRFSG_SaveConfigurationsToFile(self, vi, channel_name, file_path): # noqa: N802 with self._func_lock: if self.niRFSG_SaveConfigurationsToFile_cfunc is None: @@ -764,30 +779,6 @@ def niRFSG_SetAttributeViString(self, vi, channel_name, attribute, value): # no self.niRFSG_SetAttributeViString_cfunc.restype = ViStatus # noqa: F405 return self.niRFSG_SetAttributeViString_cfunc(vi, channel_name, attribute, value) - def niRFSG_SetWaveformBurstStartLocations(self, vi, channel_name, number_of_locations, locations): # noqa: N802 - with self._func_lock: - if self.niRFSG_SetWaveformBurstStartLocations_cfunc is None: - self.niRFSG_SetWaveformBurstStartLocations_cfunc = self._get_library_function('niRFSG_SetWaveformBurstStartLocations') - self.niRFSG_SetWaveformBurstStartLocations_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViReal64)] # noqa: F405 - self.niRFSG_SetWaveformBurstStartLocations_cfunc.restype = ViStatus # noqa: F405 - return self.niRFSG_SetWaveformBurstStartLocations_cfunc(vi, channel_name, number_of_locations, locations) - - def niRFSG_SetWaveformBurstStopLocations(self, vi, channel_name, number_of_locations, locations): # noqa: N802 - with self._func_lock: - if self.niRFSG_SetWaveformBurstStopLocations_cfunc is None: - self.niRFSG_SetWaveformBurstStopLocations_cfunc = self._get_library_function('niRFSG_SetWaveformBurstStopLocations') - self.niRFSG_SetWaveformBurstStopLocations_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViReal64)] # noqa: F405 - self.niRFSG_SetWaveformBurstStopLocations_cfunc.restype = ViStatus # noqa: F405 - return self.niRFSG_SetWaveformBurstStopLocations_cfunc(vi, channel_name, number_of_locations, locations) - - def niRFSG_SetWaveformMarkerEventLocations(self, vi, channel_name, number_of_locations, locations): # noqa: N802 - with self._func_lock: - if self.niRFSG_SetWaveformMarkerEventLocations_cfunc is None: - self.niRFSG_SetWaveformMarkerEventLocations_cfunc = self._get_library_function('niRFSG_SetWaveformMarkerEventLocations') - self.niRFSG_SetWaveformMarkerEventLocations_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViInt32, ctypes.POINTER(ViReal64)] # noqa: F405 - self.niRFSG_SetWaveformMarkerEventLocations_cfunc.restype = ViStatus # noqa: F405 - return self.niRFSG_SetWaveformMarkerEventLocations_cfunc(vi, channel_name, number_of_locations, locations) - def niRFSG_UnlockSession(self, vi, caller_has_lock): # noqa: N802 with self._func_lock: if self.niRFSG_UnlockSession_cfunc is None: diff --git a/generated/nirfsg/nirfsg/_library_interpreter.py b/generated/nirfsg/nirfsg/_library_interpreter.py index 0646b26fd..8626708e1 100644 --- a/generated/nirfsg/nirfsg/_library_interpreter.py +++ b/generated/nirfsg/nirfsg/_library_interpreter.py @@ -386,12 +386,38 @@ def disable_start_trigger(self): # noqa: N802 def export_signal(self, signal, signal_identifier, output_terminal): # noqa: N802 vi_ctype = _visatype.ViSession(self._vi) # case S110 signal_ctype = _visatype.ViInt32(signal.value) # case S130 - signal_identifier_ctype = ctypes.create_string_buffer(signal_identifier.value.encode(self._encoding)) # case C030 - output_terminal_ctype = ctypes.create_string_buffer(output_terminal.value.encode(self._encoding)) # case C030 + signal_identifier_ctype = ctypes.create_string_buffer(signal_identifier.encode(self._encoding)) # case C020 + output_terminal_ctype = ctypes.create_string_buffer(output_terminal.encode(self._encoding)) # case C020 error_code = self._library.niRFSG_ExportSignal(vi_ctype, signal_ctype, signal_identifier_ctype, output_terminal_ctype) errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) return + def get_all_named_waveform_names(self): # noqa: N802 + vi_ctype = _visatype.ViSession(self._vi) # case S110 + waveform_names_ctype = None # case C050 + buffer_size_ctype = _visatype.ViInt32() # case S170 + actual_buffer_size_ctype = _visatype.ViInt32() # case S220 + error_code = self._library.niRFSG_GetAllNamedWaveformNames(vi_ctype, waveform_names_ctype, buffer_size_ctype, None if actual_buffer_size_ctype is None else (ctypes.pointer(actual_buffer_size_ctype))) + errors.handle_error(self, error_code, ignore_warnings=True, is_error_handling=False) + buffer_size_ctype = _visatype.ViInt32(error_code) # case S180 + waveform_names_ctype = (_visatype.ViChar * buffer_size_ctype.value)() # case C060 + error_code = self._library.niRFSG_GetAllNamedWaveformNames(vi_ctype, waveform_names_ctype, buffer_size_ctype, None if actual_buffer_size_ctype is None else (ctypes.pointer(actual_buffer_size_ctype))) + errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) + return waveform_names_ctype.value.decode(self._encoding), int(actual_buffer_size_ctype.value) + + def get_all_script_names(self): # noqa: N802 + vi_ctype = _visatype.ViSession(self._vi) # case S110 + script_names_ctype = None # case C050 + buffer_size_ctype = _visatype.ViInt32() # case S170 + actual_buffer_size_ctype = _visatype.ViInt32() # case S220 + error_code = self._library.niRFSG_GetAllScriptNames(vi_ctype, script_names_ctype, buffer_size_ctype, None if actual_buffer_size_ctype is None else (ctypes.pointer(actual_buffer_size_ctype))) + errors.handle_error(self, error_code, ignore_warnings=True, is_error_handling=False) + buffer_size_ctype = _visatype.ViInt32(error_code) # case S180 + script_names_ctype = (_visatype.ViChar * buffer_size_ctype.value)() # case C060 + error_code = self._library.niRFSG_GetAllScriptNames(vi_ctype, script_names_ctype, buffer_size_ctype, None if actual_buffer_size_ctype is None else (ctypes.pointer(actual_buffer_size_ctype))) + errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) + return script_names_ctype.value.decode(self._encoding), int(actual_buffer_size_ctype.value) + def get_attribute_vi_boolean(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 @@ -451,6 +477,19 @@ 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_error(self): # noqa: N802 vi_ctype = _visatype.ViSession(self._vi) # case S110 error_code_ctype = _visatype.ViStatus() # case S220 @@ -512,35 +551,19 @@ def get_stream_endpoint_handle(self, stream_endpoint): # noqa: N802 errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) return int(reader_handle_ctype.value) - def get_waveform_burst_start_locations(self, channel_name, number_of_locations): # noqa: N802 - vi_ctype = _visatype.ViSession(self._vi) # case S110 - channel_name_ctype = ctypes.create_string_buffer(channel_name.encode(self._encoding)) # case C010 - number_of_locations_ctype = _visatype.ViInt32(number_of_locations) # case S150 - locations_ctype = _visatype.ViReal64() # case S220 - required_size_ctype = _visatype.ViInt32() # case S220 - error_code = self._library.niRFSG_GetWaveformBurstStartLocations(vi_ctype, channel_name_ctype, number_of_locations_ctype, None if locations_ctype is None else (ctypes.pointer(locations_ctype)), None if required_size_ctype is None else (ctypes.pointer(required_size_ctype))) - errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) - return float(locations_ctype.value), int(required_size_ctype.value) - - def get_waveform_burst_stop_locations(self, channel_name, number_of_locations): # noqa: N802 - vi_ctype = _visatype.ViSession(self._vi) # case S110 - channel_name_ctype = ctypes.create_string_buffer(channel_name.encode(self._encoding)) # case C010 - number_of_locations_ctype = _visatype.ViInt32(number_of_locations) # case S150 - locations_ctype = _visatype.ViReal64() # case S220 - required_size_ctype = _visatype.ViInt32() # case S220 - error_code = self._library.niRFSG_GetWaveformBurstStopLocations(vi_ctype, channel_name_ctype, number_of_locations_ctype, None if locations_ctype is None else (ctypes.pointer(locations_ctype)), None if required_size_ctype is None else (ctypes.pointer(required_size_ctype))) - errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) - return float(locations_ctype.value), int(required_size_ctype.value) - - def get_waveform_marker_event_locations(self, channel_name, number_of_locations): # noqa: N802 + def get_terminal_name(self, signal, signal_identifier): # noqa: N802 vi_ctype = _visatype.ViSession(self._vi) # case S110 - channel_name_ctype = ctypes.create_string_buffer(channel_name.encode(self._encoding)) # case C010 - number_of_locations_ctype = _visatype.ViInt32(number_of_locations) # case S150 - locations_ctype = _visatype.ViReal64() # case S220 - required_size_ctype = _visatype.ViInt32() # case S220 - error_code = self._library.niRFSG_GetWaveformMarkerEventLocations(vi_ctype, channel_name_ctype, number_of_locations_ctype, None if locations_ctype is None else (ctypes.pointer(locations_ctype)), None if required_size_ctype is None else (ctypes.pointer(required_size_ctype))) + signal_ctype = _visatype.ViInt32(signal.value) # case S130 + signal_identifier_ctype = ctypes.create_string_buffer(signal_identifier.encode(self._encoding)) # case C020 + buffer_size_ctype = _visatype.ViInt32() # case S170 + terminal_name_ctype = None # case C050 + error_code = self._library.niRFSG_GetTerminalName(vi_ctype, signal_ctype, signal_identifier_ctype, buffer_size_ctype, terminal_name_ctype) + errors.handle_error(self, error_code, ignore_warnings=True, is_error_handling=False) + buffer_size_ctype = _visatype.ViInt32(error_code) # case S180 + terminal_name_ctype = (_visatype.ViChar * buffer_size_ctype.value)() # case C060 + error_code = self._library.niRFSG_GetTerminalName(vi_ctype, signal_ctype, signal_identifier_ctype, buffer_size_ctype, terminal_name_ctype) errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) - return float(locations_ctype.value), int(required_size_ctype.value) + return terminal_name_ctype.value.decode(self._encoding) def init_with_options(self, resource_name, id_query, reset_device, option_string): # noqa: N802 resource_name_ctype = ctypes.create_string_buffer(resource_name.encode(self._encoding)) # case C020 @@ -629,6 +652,13 @@ def reset_with_defaults(self): # noqa: N802 errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) return + def reset_with_options(self, steps_to_omit): # noqa: N802 + vi_ctype = _visatype.ViSession(self._vi) # case S110 + steps_to_omit_ctype = _visatype.ViUInt64(steps_to_omit.value) # case S130 + error_code = self._library.niRFSG_ResetWithOptions(vi_ctype, steps_to_omit_ctype) + errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) + return + 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 @@ -672,7 +702,7 @@ def self_test(self, self_test_message): # noqa: N802 def send_software_edge_trigger(self, trigger, trigger_identifier): # noqa: N802 vi_ctype = _visatype.ViSession(self._vi) # case S110 trigger_ctype = _visatype.ViInt32(trigger.value) # case S130 - trigger_identifier_ctype = ctypes.create_string_buffer(trigger_identifier.value.encode(self._encoding)) # case C030 + trigger_identifier_ctype = ctypes.create_string_buffer(trigger_identifier.encode(self._encoding)) # case C020 error_code = self._library.niRFSG_SendSoftwareEdgeTrigger(vi_ctype, trigger_ctype, trigger_identifier_ctype) errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) return @@ -740,33 +770,6 @@ def set_attribute_vi_string(self, channel_name, attribute, value): # noqa: N802 errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) return - def set_waveform_burst_start_locations(self, channel_name, number_of_locations): # noqa: N802 - vi_ctype = _visatype.ViSession(self._vi) # case S110 - channel_name_ctype = ctypes.create_string_buffer(channel_name.encode(self._encoding)) # case C010 - number_of_locations_ctype = _visatype.ViInt32(number_of_locations) # case S150 - locations_ctype = _visatype.ViReal64() # case S220 - error_code = self._library.niRFSG_SetWaveformBurstStartLocations(vi_ctype, channel_name_ctype, number_of_locations_ctype, None if locations_ctype is None else (ctypes.pointer(locations_ctype))) - errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) - return float(locations_ctype.value) - - def set_waveform_burst_stop_locations(self, channel_name, number_of_locations): # noqa: N802 - vi_ctype = _visatype.ViSession(self._vi) # case S110 - channel_name_ctype = ctypes.create_string_buffer(channel_name.encode(self._encoding)) # case C010 - number_of_locations_ctype = _visatype.ViInt32(number_of_locations) # case S150 - locations_ctype = _visatype.ViReal64() # case S220 - error_code = self._library.niRFSG_SetWaveformBurstStopLocations(vi_ctype, channel_name_ctype, number_of_locations_ctype, None if locations_ctype is None else (ctypes.pointer(locations_ctype))) - errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) - return float(locations_ctype.value) - - def set_waveform_marker_event_locations(self, channel_name, number_of_locations): # noqa: N802 - vi_ctype = _visatype.ViSession(self._vi) # case S110 - channel_name_ctype = ctypes.create_string_buffer(channel_name.encode(self._encoding)) # case C010 - number_of_locations_ctype = _visatype.ViInt32(number_of_locations) # case S150 - locations_ctype = _visatype.ViReal64() # case S220 - error_code = self._library.niRFSG_SetWaveformMarkerEventLocations(vi_ctype, channel_name_ctype, number_of_locations_ctype, None if locations_ctype is None else (ctypes.pointer(locations_ctype))) - errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) - return float(locations_ctype.value) - def unlock(self): # noqa: N802 vi_ctype = _visatype.ViSession(self._vi) # case S110 error_code = self._library.niRFSG_UnlockSession(vi_ctype, None) diff --git a/generated/nirfsg/nirfsg/enums.py b/generated/nirfsg/nirfsg/enums.py index 05cc3a176..6d6fe66b4 100644 --- a/generated/nirfsg/nirfsg/enums.py +++ b/generated/nirfsg/nirfsg/enums.py @@ -108,17 +108,6 @@ class ArbOnboardSampleClockMode(Enum): ''' -class ArbSampleClockSource(Enum): - ONBOARD_CLOCK = 'OnboardClock' - r''' - Uses the AWG module onboard clock as the Sample Clock source. - ''' - CLK_IN = 'ClkIn' - r''' - Uses the external clock as the Sample Clock source. - ''' - - class AutomaticLevelControl(Enum): DISABLE = 0 r''' @@ -159,196 +148,6 @@ class ConfigListTrigDigEdgeEdge(Enum): ''' -class ConfigListTrigDigEdgeSource(Enum): - PFI0 = 'PFI0' - r''' - The trigger is received on PFI 0. - ''' - PFI1 = 'PFI1' - r''' - The trigger is received on PFI 1. - ''' - PXI_TRIG0 = 'PXI_Trig0' - r''' - The trigger is received on PXI trigger line 0. - ''' - PXI_TRIG1 = 'PXI_Trig1' - r''' - The trigger is received on PXI trigger line 1. - ''' - PXI_TRIG2 = 'PXI_Trig2' - r''' - The trigger is received on PXI trigger line 2. - ''' - PXI_TRIG3 = 'PXI_Trig3' - r''' - The trigger is received on PXI trigger line 3. - ''' - PXI_TRIG4 = 'PXI_Trig4' - r''' - The trigger is received on PXI trigger line 4. - ''' - PXI_TRIG5 = 'PXI_Trig5' - r''' - The trigger is received on PXI trigger line 5. - ''' - PXI_TRIG6 = 'PXI_Trig6' - r''' - The trigger is received on PXI trigger line 6. - ''' - PXI_TRIG7 = 'PXI_Trig7' - r''' - The trigger is received on PXI trigger line 7. - ''' - PXI_STAR = 'PXI_Star' - r''' - The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646. - ''' - PXIE_DSTARB = 'PXIe_DStarB' - r''' - The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5840/5841/5842. - ''' - MARKER0_EVENT = 'Marker0Event' - r''' - The trigger is received from the Marker Event 0. - ''' - MARKER1_EVENT = 'Marker1Event' - r''' - The trigger is received from the Marker Event 1. - ''' - MARKER2_EVENT = 'Marker2Event' - r''' - The trigger is received from the Marker Event 2. - ''' - MARKER3_EVENT = 'Marker3Event' - r''' - The trigger is received from the Marker Event 3. - ''' - TIMER_EVENT = 'TimerEvent' - r''' - The trigger is received from the Timer Event. - ''' - TRIG_IN = 'TrigIn' - r''' - The trigger is received on the TRIG IN/OUT terminal. This value is valid on only the PXIe-5654/5654 with PXIe-5696. - ''' - DIO0 = 'DIO/PFI0' - r''' - The trigger is received on PFI0 from the front panel DIO terminal. - ''' - DIO1 = 'DIO/PFI1' - r''' - The trigger is received on PFI1 from the front panel DIO terminal. - ''' - DIO2 = 'DIO/PFI2' - r''' - The trigger is received on PFI2 from the front panel DIO terminal. - ''' - DIO3 = 'DIO/PFI3' - r''' - The trigger is received on PFI3 from the front panel DIO terminal. - ''' - DIO4 = 'DIO/PFI4' - r''' - The trigger is received on PFI4 from the front panel DIO terminal. - ''' - DIO5 = 'DIO/PFI5' - r''' - The trigger is received on PFI5 from the front panel DIO terminal. - ''' - DIO6 = 'DIO/PFI6' - r''' - The trigger is received on PFI6 from the front panel DIO terminal. - ''' - DIO7 = 'DIO/PFI7' - r''' - The trigger is received on PFI7 from the front panel DIO terminal. - ''' - - -class ConfigListTrigExportOutputTerm(Enum): - DO_NOT_EXPORT = '' - r''' - The signal is not exported. - ''' - PFI0 = 'PFI0' - r''' - The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. - ''' - PFI1 = 'PFI1' - r''' - The signal is exported on PFI 1 connector. - ''' - PXI_TRIG0 = 'PXI_Trig0' - r''' - The signal is exported to the PXI trigger line 0. . - ''' - PXI_TRIG1 = 'PXI_Trig1' - r''' - The signal is exported to the PXI trigger line 0. - ''' - PXI_TRIG2 = 'PXI_Trig2' - r''' - The signal is exported to the PXI trigger line 2. - ''' - PXI_TRIG3 = 'PXI_Trig3' - r''' - The signal is exported to the PXI trigger line 3. - ''' - PXI_TRIG4 = 'PXI_Trig4' - r''' - The signal is exported to the PXI trigger line 4. - ''' - PXI_TRIG5 = 'PXI_Trig5' - r''' - The signal is exported to the PXI trigger line 5. - ''' - PXI_TRIG6 = 'PXI_Trig6' - r''' - The signal is exported to the PXI trigger line 6. - ''' - PXIE_DSTARC = 'PXIe_DStarC' - r''' - The trigger is received on the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5840/5841/5842. - ''' - TRIG_OUT = 'TrigOut' - r''' - The trigger is received on the TRIG IN/OUT terminal. This value is valid on only the PXIe-5654/5654 with PXIe-5696. - ''' - DIO0 = 'DIO/PFI0' - r''' - The trigger is received on PFI0 from the front panel DIO terminal. - ''' - DIO1 = 'DIO/PFI1' - r''' - The trigger is received on PFI1 from the front panel DIO terminal. - ''' - DIO2 = 'DIO/PFI2' - r''' - The trigger is received on PFI2 from the front panel DIO terminal. - ''' - DIO3 = 'DIO/PFI3' - r''' - The trigger is received on PFI3 from the front panel DIO terminal. - ''' - DIO4 = 'DIO/PFI4' - r''' - The trigger is received on PFI4 from the front panel DIO terminal. - ''' - DIO5 = 'DIO/PFI5' - r''' - The trigger is received on PFI5 from the front panel DIO terminal. - ''' - DIO6 = 'DIO/PFI6' - r''' - The trigger is received on PFI6 from the front panel DIO terminal. - ''' - DIO7 = 'DIO/PFI7' - r''' - The trigger is received on PFI7 from the front panel DIO terminal. - ''' - - class ConfigListTrigType(Enum): NONE = 0 r''' @@ -356,7 +155,7 @@ class ConfigListTrigType(Enum): ''' DIGITAL_EDGE = 1 r''' - Data operation does not start until a digital edge is detected. The source of the digital edge is specified in the %property{digital edge configuration list step trigger source} property, and the active edge is always rising. + Data operation does not start until a digital edge is detected. The source of the digital edge is specified in the DIGITAL_EDGE_CONFIGURATION_LIST_STEP_TRIGGER_SOURCE property, and the active edge is always rising. ''' @@ -373,60 +172,16 @@ class ConfigurationListRepeat(Enum): SCRIPT_TRIGGER = 1 -class ConfigurationSettledEventExportOutputTerm(Enum): - DO_NOT_EXPORT = '' - r''' - The signal is not exported. - ''' - PXI_TRIG0 = 'PXI_Trig0' - r''' - PXI trigger line 0. - ''' - PXI_TRIG1 = 'PXI_Trig1' - r''' - PXI trigger line 1. - ''' - PXI_TRIG2 = 'PXI_Trig2' - r''' - PXI trigger line 2. - ''' - PXI_TRIG3 = 'PXI_Trig3' - r''' - PXI trigger line 3. - ''' - PXI_TRIG4 = 'PXI_Trig4' - r''' - PXI trigger line 4. - ''' - PXI_TRIG5 = 'PXI_Trig5' - r''' - PXI trigger line 5. - ''' - PXI_TRIG6 = 'PXI_Trig6' - r''' - PXI trigger line 6. - ''' - PXIE_DSTARC = 'PXIe_DStarC' - r''' - PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842. - ''' - TRIG_OUT = 'TrigOut' - r''' - TRIG IN/OUT terminal. - ''' - - class DeembeddingTypeAttrVals(Enum): - DEEMBEDDING_TYPE_NONE = 25000 + NONE = 25000 r''' De-embedding is not applied to the measurement. ''' - NONE = 0 - DEEMBEDDING_TYPE_SCALAR = 25001 + SCALAR = 25001 r''' De-embeds the measurement using only the gain term. ''' - DEEMBEDDING_TYPE_VECTOR = 25002 + VECTOR = 25002 r''' De-embeds the measurement using the gain term and the reflection term. ''' @@ -458,7 +213,7 @@ class DigModWfmType(Enum): ''' USER_DEFINED = 5001 r''' - Specifies that the digital modulation waveform type is user defined. To specify the user-defined waveform, call the %method{configure digital modulation user defined waveform} method. + 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. ''' @@ -488,93 +243,6 @@ class DirectDownload(Enum): ''' -class DoneEventExportOutputTerm(Enum): - DO_NOT_EXPORT = '' - r''' - The signal is not exported. - ''' - PFI0 = 'PFI0' - r''' - The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. - ''' - PFI1 = 'PFI1' - r''' - The signal is exported to the PFI 1 connector. - ''' - PFI4 = 'PFI4' - r''' - The signal is exported to the PFI 4 connector. - ''' - PFI5 = 'PFI5' - r''' - The signal is exported to the PFI 5 connector. - ''' - PXI_TRIG0 = 'PXI_Trig0' - r''' - The signal is exported to the PXI trigger line 0. - ''' - PXI_TRIG1 = 'PXI_Trig1' - r''' - The signal is exported to the PXI trigger line 1. - ''' - PXI_TRIG2 = 'PXI_Trig2' - r''' - The signal is exported to the PXI trigger line 2. - ''' - PXI_TRIG3 = 'PXI_Trig3' - r''' - The signal is exported to the PXI trigger line 3. - ''' - PXI_TRIG4 = 'PXI_Trig4' - r''' - The signal is exported to the PXI trigger line 4. - ''' - PXI_TRIG5 = 'PXI_Trig5' - r''' - The signal is exported to the PXI trigger line 5. - ''' - PXI_TRIG6 = 'PXI_Trig6' - r''' - The signal is exported to the PXI trigger line 6. - ''' - PXIE_DSTARC = 'PXIe_DStarC' - r''' - The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841. - ''' - DIO0 = 'DIO/PFI0' - r''' - The trigger is received on PFI0 from the front panel DIO terminal. - ''' - DIO1 = 'DIO/PFI1' - r''' - The trigger is received on PFI1 from the front panel DIO terminal. - ''' - DIO2 = 'DIO/PFI2' - r''' - The trigger is received on PFI2 from the front panel DIO terminal. - ''' - DIO3 = 'DIO/PFI3' - r''' - The trigger is received on PFI3 from the front panel DIO terminal. - ''' - DIO4 = 'DIO/PFI4' - r''' - The trigger is received on PFI4 from the front panel DIO terminal. - ''' - DIO5 = 'DIO/PFI5' - r''' - The trigger is received on PFI5 from the front panel DIO terminal. - ''' - DIO6 = 'DIO/PFI6' - r''' - The trigger is received on PFI6 from the front panel DIO terminal. - ''' - DIO7 = 'DIO/PFI7' - r''' - The trigger is received on PFI7 from the front panel DIO terminal. - ''' - - class FilterType(Enum): NONE = 0 r''' @@ -582,11 +250,11 @@ class FilterType(Enum): ''' ARB_FILTER_TYPE_ROOT_RAISED_COSINE = 10001 r''' - Applies a root-raised cosine filter to the data with the alpha value specified with the %property{arb filter root raised cosine alpha} property. + 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 %property{arb filter raised cosine alpha} property. + Applies a raised cosine filter to the data with the alpha value specified with the arb_filter_raised_cosine_alpha property. ''' @@ -627,11 +295,11 @@ class GenerationMode(Enum): ''' ARB_WAVEFORM = 1001 r''' - Configures the RF signal generator to generate the arbitrary waveform specified by the %property{arb selected waveform} property. + Configures the RF signal generator to generate the arbitrary waveform specified by the arb_selected_waveform property. ''' SCRIPT = 1002 r''' - Configures the RF signal generator to generate arbitrary waveforms as directed by the %property{selected script} property. + Configures the RF signal generator to generate arbitrary waveforms as directed by the selected_script property. ''' @@ -696,40 +364,15 @@ class LoPlLfractionalModeEnabled(Enum): SCRIPT_TRIGGER = 1 -class LoSource(Enum): - ONBOARD = 'Onboard' - r''' - Uses an internal LO as the LO source. If you specify an internal LO source, the LO is generated inside the device itself. - ''' - LO_IN = 'LO_In' - r''' - Uses an external LO as the LO source. Connect a signal to the LO IN connector on the device and use the %property{upconverter center frequency} property to specify the LO frequency. - ''' - SECONDARY = 'Secondary' - r''' - Uses the PXIe-5831/5840 internal LO as the LO source. This value is valid only on the PXIe-5831 with PXIe-5653 and PXIe-5832 with PXIe-5653. - ''' - SG_SA_SHARED = 'SG_SA_Shared' - r''' - Uses the same internal LO during NI-RFSA and NI-RFSG sessions. NI-RFSG selects an internal synthesizer and the synthesizer signal is switched to both the RF In and RF Out mixers. This value is valid only on the PXIe-5830/5831/5832/5841 with PXIe-5655/5842. - ''' - AUTOMATIC_SG_SA_SHARED = 'Automatic_SG_SA_Shared' - r''' - NI-RFSG internally makes the configuration to share the LO between NI-RFSA and NI-RFSG. This value is valid only on the PXIe-5820/5830/5831/5832/5840/5841/5842. - ''' - - class LoadOptions(Enum): - RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_LOAD_OPTIONS_SKIP_NONE = 0 + NONE = 0 r''' NI-RFSG loads all the configurations to the session. ''' - MANUAL = 0 - RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_LOAD_OPTIONS_SKIP_WAVEFORM = 1 + WAVEFORMS = 1 r''' NI-RFSG skips loading the waveform configurations to the session. ''' - SCRIPT_TRIGGER = 1 class LoopBandwidth(Enum): @@ -747,93 +390,6 @@ class LoopBandwidth(Enum): ''' -class MarkerEventExportOutputTerm(Enum): - DO_NOT_EXPORT = '' - r''' - The signal is not exported. - ''' - PFI0 = 'PFI0' - r''' - The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. - ''' - PFI1 = 'PFI1' - r''' - The signal is exported to the PFI 1 connector. - ''' - PFI4 = 'PFI4' - r''' - The signal is exported to the PFI 4 connector. - ''' - PFI5 = 'PFI5' - r''' - The signal is exported to the PFI 5 connector. - ''' - PXI_TRIG0 = 'PXI_Trig0' - r''' - The signal is exported to PXI trigger line 0. - ''' - PXI_TRIG1 = 'PXI_Trig1' - r''' - The signal is exported to PXI trigger line 1. - ''' - PXI_TRIG2 = 'PXI_Trig2' - r''' - The signal is exported to PXI trigger line 2. - ''' - PXI_TRIG3 = 'PXI_Trig3' - r''' - The signal is exported to PXI trigger line 3. - ''' - PXI_TRIG4 = 'PXI_Trig4' - r''' - The signal is exported to PXI trigger line 4. - ''' - PXI_TRIG5 = 'PXI_Trig5' - r''' - The signal is exported to PXI trigger line 5. - ''' - PXI_TRIG6 = 'PXI_Trig6' - r''' - The signal is exported to PXI trigger line 6. - ''' - PXIE_DSTARC = 'PXIe_DStarC' - r''' - The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841. - ''' - DIO0 = 'DIO/PFI0' - r''' - The trigger is received on PFI0 from the front panel DIO terminal. - ''' - DIO1 = 'DIO/PFI1' - r''' - The trigger is received on PFI1 from the front panel DIO terminal. - ''' - DIO2 = 'DIO/PFI2' - r''' - The trigger is received on PFI2 from the front panel DIO terminal. - ''' - DIO3 = 'DIO/PFI3' - r''' - The trigger is received on PFI3 from the front panel DIO terminal. - ''' - DIO4 = 'DIO/PFI4' - r''' - The trigger is received on PFI4 from the front panel DIO terminal. - ''' - DIO5 = 'DIO/PFI5' - r''' - The trigger is received on PFI5 from the front panel DIO terminal. - ''' - DIO6 = 'DIO/PFI6' - r''' - The trigger is received on PFI6 from the front panel DIO terminal. - ''' - DIO7 = 'DIO/PFI7' - r''' - The trigger is received on PFI7 from the front panel DIO terminal. - ''' - - class MarkerEventOutputBehavior(Enum): PULSE = 23000 r''' @@ -956,7 +512,7 @@ class PowerLevelType(Enum): ''' PEAK = 7001 r''' - Indicates the maximum power level of the RF signal averaged over one period of the RF carrier frequency (the peak envelope power). This setting requires that the magnitude of the I/Q waveform must always be less than or equal to one. When using peak power, the power level of the RF signal matches the specified power level at moments when the magnitude of the I/Q waveform equals one. If you write more than one waveform, the relative scaling between waveforms is preserved. In peak power mode, waveforms are scaled according to the %property{arb waveform software scaling factor} property. You can use the %property{peak power adjustment} property in conjunction with the %property{power level} property when the %property{power level type} property is set to %enum_value{power level type.peak power}. + Indicates the maximum power level of the RF signal averaged over one period of the RF carrier frequency (the peak envelope power). This setting requires that the magnitude of the I/Q waveform must always be less than or equal to one. When using peak power, the power level of the RF signal matches the specified power level at moments when the magnitude of the I/Q waveform equals one. If you write more than one waveform, the relative scaling between waveforms is preserved. In peak power mode, waveforms are scaled according to the arb_waveform_software_scaling_factor property. You can use the peak_power_adjustment property in conjunction with the power_level property when the power_level_type property is set to PowerLevelType.PEAK. ''' @@ -994,56 +550,6 @@ class PulseModulationMode(Enum): ''' -class PulseModulationOutputTerm(Enum): - DO_NOT_EXPORT = '' - r''' - Pulse modulation video signal is not exported. - ''' - PULSE_OUT = 'PulseOut' - r''' - Export the pulse modulation video signal on the pulse out terminal. - ''' - - -class PulseModulationSource(Enum): - PULSE_IN = 'PulseIn' - r''' - The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842. - ''' - MARKER0 = 'Marker0' - r''' - The trigger is received from the Marker 0. - ''' - MARKER1 = 'Marker1' - r''' - The trigger is received from the Marker 1. - ''' - MARKER2 = 'Marker2' - r''' - The trigger is received from the Marker 2. - ''' - MARKER3 = 'Marker3' - r''' - The trigger is received from the Marker 3. - ''' - - -class PxiChassisClk10Source(Enum): - NONE = 0 - r''' - Do not drive the PXI_CLK10 signal. - ''' - DO_NOT_EXPORT_STR = '' - ONBOARD_CLOCK_STR = 'OnboardClock' - r''' - Uses the highly stable oven-controlled onboard Reference Clock to drive the PXI_CLK signal. - ''' - REF_IN_STR = 'RefIn' - r''' - Uses the clock present at the front panel REF IN connector to drive the PXI_CLK signal. - ''' - - class RFBlanking(Enum): DISABLE = 0 r''' @@ -1088,25 +594,6 @@ class RFInLoExportEnabled(Enum): SCRIPT_TRIGGER = 1 -class ReferenceClockExportOutputTerminal(Enum): - DO_NOT_EXPORT = '' - r''' - The Reference Clock signal is not exported. - ''' - REF_OUT = 'RefOut' - r''' - Exports the Reference Clock signal to the REF OUT connector of the device. - ''' - REF_OUT2 = 'RefOut2' - r''' - Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable. - ''' - CLK_OUT = 'ClkOut' - r''' - Exports the Reference Clock signal to the CLK OUT connector of the device. - ''' - - class ReferenceClockExportedRate(Enum): _10mhz = 10000000 r''' @@ -1133,33 +620,6 @@ class ReferenceClockRate(Enum): ''' -class ReferenceClockSource(Enum): - ONBOARD_CLOCK = 'OnboardClock' - r''' - Uses the onboard Reference Clock as the clock source. - ''' - REF_IN = 'RefIn' - r''' - Uses the clock signal present at the front panel REF IN connector as the Reference Clock source. - ''' - PXI_CLK = 'PXI_CLK' - r''' - Uses the PXI_CLK signal, which is present on the PXI backplane, as the Reference Clock source. - ''' - CLK_IN = 'ClkIn' - r''' - Uses the clock signal present at the front panel CLK IN connector as the Reference Clock source. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5831 with PXIe-5653/5832/5832 with PXIe-5653/5840/5841/5841 with PXIe-5655. - ''' - REF_IN_2 = 'RefIn2' - r''' - This value is not valid on any supported devices. - ''' - PXI_CLK_MASTER = 'PXI_ClkMaster' - r''' - 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 ReferenceClockSource.PXI_CLK %enum_value as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector. - ''' - - class RelativeTo(Enum): CURRENT_POSITION = 8001 r''' @@ -1228,105 +688,6 @@ class ScriptTrigDigEdgeEdge(Enum): ''' -class ScriptTrigDigEdgeSource(Enum): - PFI0 = 'PFI0' - r''' - The trigger is received on PFI 0. - ''' - PFI1 = 'PFI1' - r''' - The trigger is received on PFI 1. - ''' - PFI2 = 'PFI2' - r''' - The trigger is received on PFI 2. - ''' - PFI3 = 'PFI3' - r''' - The trigger is received on PFI 3. - ''' - PXI_TRIG0 = 'PXI_Trig0' - r''' - The trigger is received on PXI trigger line 0. - ''' - PXI_TRIG1 = 'PXI_Trig1' - r''' - The trigger is received on PXI trigger line 1. - ''' - PXI_TRIG2 = 'PXI_Trig2' - r''' - The trigger is received on PXI trigger line 2. - ''' - PXI_TRIG3 = 'PXI_Trig3' - r''' - The trigger is received on PXI trigger line 3. - ''' - PXI_TRIG4 = 'PXI_Trig4' - r''' - The trigger is received on PXI trigger line 4. - ''' - PXI_TRIG5 = 'PXI_Trig5' - r''' - The trigger is received on PXI trigger line 5. - ''' - PXI_TRIG6 = 'PXI_Trig6' - r''' - The trigger is received on PXI trigger line 6. - ''' - PXI_TRIG7 = 'PXI_Trig7' - r''' - The trigger is received on PXI trigger line 7. - ''' - PXI_STAR = 'PXI_Star' - r''' - The trigger is received on the PXI star trigger line. This value is not valid on the PXIe-5644/5645/5646. - ''' - PXIE_DSTARB = 'PXIe_DStarB' - r''' - The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/ - ''' - PULSE_IN = 'PulseIn' - r''' - The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842. - ''' - DIO0 = 'DIO/PFI0' - r''' - The trigger is received on PFI0 from the front panel DIO terminal. - ''' - DIO1 = 'DIO/PFI1' - r''' - The trigger is received on PFI1 from the front panel DIO terminal. - ''' - DIO2 = 'DIO/PFI2' - r''' - The trigger is received on PFI2 from the front panel DIO terminal. - ''' - DIO3 = 'DIO/PFI3' - r''' - The trigger is received on PFI3 from the front panel DIO terminal. - ''' - DIO4 = 'DIO/PFI4' - r''' - The trigger is received on PFI4 from the front panel DIO terminal. - ''' - DIO5 = 'DIO/PFI5' - r''' - The trigger is received on PFI5 from the front panel DIO terminal. - ''' - DIO6 = 'DIO/PFI6' - r''' - The trigger is received on PFI6 from the front panel DIO terminal. - ''' - DIO7 = 'DIO/PFI7' - r''' - The trigger is received on PFI7 from the front panel DIO terminal. - ''' - SYNC_SCRIPT_TRIGGER = 'Sync_Script' - r''' - The trigger is received on the Sync Script trigger line. This value is valid on only the PXIe-5644/5645/5646. - ''' - - class ScriptTrigDigLevelActiveLevel(Enum): HIGH = 9000 r''' @@ -1338,188 +699,6 @@ class ScriptTrigDigLevelActiveLevel(Enum): ''' -class ScriptTrigDigLevelSource(Enum): - PFI0 = 'PFI0' - r''' - The trigger is received on PFI 0. - ''' - PFI1 = 'PFI1' - r''' - The trigger is received on PFI 1. - ''' - PFI2 = 'PFI2' - r''' - The trigger is received on PFI 2. - ''' - PFI3 = 'PFI3' - r''' - The trigger is received on PFI 3. - ''' - PXI_TRIG0 = 'PXI_Trig0' - r''' - The trigger is received on PXI trigger line 0. - ''' - PXI_TRIG1 = 'PXI_Trig1' - r''' - The trigger is received on PXI trigger line 1. - ''' - PXI_TRIG2 = 'PXI_Trig2' - r''' - The trigger is received on PXI trigger line 2. - ''' - PXI_TRIG3 = 'PXI_Trig3' - r''' - The trigger is received on PXI trigger line 3. - ''' - PXI_TRIG4 = 'PXI_Trig4' - r''' - The trigger is received on PXI trigger line 4. - ''' - PXI_TRIG5 = 'PXI_Trig5' - r''' - The trigger is received on PXI trigger line 5. - ''' - PXI_TRIG6 = 'PXI_Trig6' - r''' - The trigger is received on PXI trigger line 6. - ''' - PXI_TRIG7 = 'PXI_Trig7' - r''' - The trigger is received on PXI trigger line 7. - ''' - PXI_STAR = 'PXI_Star' - r''' - The trigger is received on the PXI star trigger line. This value is not valid on the PXIe-5644/5645/5646. - ''' - PXIE_DSTARB = 'PXIe_DStarB' - r''' - The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/ - ''' - PULSE_IN = 'PulseIn' - r''' - The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842. - ''' - DIO0 = 'DIO/PFI0' - r''' - The trigger is received on PFI0 from the front panel DIO terminal. - ''' - DIO1 = 'DIO/PFI1' - r''' - The trigger is received on PFI1 from the front panel DIO terminal. - ''' - DIO2 = 'DIO/PFI2' - r''' - The trigger is received on PFI2 from the front panel DIO terminal. - ''' - DIO3 = 'DIO/PFI3' - r''' - The trigger is received on PFI3 from the front panel DIO terminal. - ''' - DIO4 = 'DIO/PFI4' - r''' - The trigger is received on PFI4 from the front panel DIO terminal. - ''' - DIO5 = 'DIO/PFI5' - r''' - The trigger is received on PFI5 from the front panel DIO terminal. - ''' - DIO6 = 'DIO/PFI6' - r''' - The trigger is received on PFI6 from the front panel DIO terminal. - ''' - DIO7 = 'DIO/PFI7' - r''' - The trigger is received on PFI7 from the front panel DIO terminal. - ''' - - -class ScriptTrigExportOutputTerm(Enum): - DO_NOT_EXPORT = '' - r''' - The signal is not exported. - ''' - PFI0 = 'PFI0' - r''' - The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. - ''' - PFI1 = 'PFI1' - r''' - The signal is exported to the PFI 1 connector. - ''' - PFI4 = 'PFI4' - r''' - The signal is exported to the PFI 4 connector. - ''' - PFI5 = 'PFI5' - r''' - The signal is exported to the PFI 5 connector. - ''' - PXI_TRIG0 = 'PXI_Trig0' - r''' - The signal is exported to the PXI trigger line 0. - ''' - PXI_TRIG1 = 'PXI_Trig1' - r''' - The signal is exported to the PXI trigger line 1. - ''' - PXI_TRIG2 = 'PXI_Trig2' - r''' - The signal is exported to the PXI trigger line 2. - ''' - PXI_TRIG3 = 'PXI_Trig3' - r''' - The signal is exported to the PXI trigger line 3. - ''' - PXI_TRIG4 = 'PXI_Trig4' - r''' - The signal is exported to the PXI trigger line 4. - ''' - PXI_TRIG5 = 'PXI_Trig5' - r''' - The signal is exported to the PXI trigger line 5. - ''' - PXI_TRIG6 = 'PXI_Trig6' - r''' - The signal is exported to the PXI trigger line 6. - ''' - PXIE_DSTARC = 'PXIe_DStarC' - r''' - The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/ - ''' - DIO0 = 'DIO/PFI0' - r''' - The trigger is received on PFI0 from the front panel DIO terminal. - ''' - DIO1 = 'DIO/PFI1' - r''' - The trigger is received on PFI1 from the front panel DIO terminal. - ''' - DIO2 = 'DIO/PFI2' - r''' - The trigger is received on PFI2 from the front panel DIO terminal. - ''' - DIO3 = 'DIO/PFI3' - r''' - The trigger is received on PFI3 from the front panel DIO terminal. - ''' - DIO4 = 'DIO/PFI4' - r''' - The trigger is received on PFI4 from the front panel DIO terminal. - ''' - DIO5 = 'DIO/PFI5' - r''' - The trigger is received on PFI5 from the front panel DIO terminal. - ''' - DIO6 = 'DIO/PFI6' - r''' - The trigger is received on PFI6 from the front panel DIO terminal. - ''' - DIO7 = 'DIO/PFI7' - r''' - The trigger is received on PFI7 from the front panel DIO terminal. - ''' - - class ScriptTrigType(Enum): NONE = 0 r''' @@ -1527,15 +706,15 @@ class ScriptTrigType(Enum): ''' DIGITAL_EDGE = 1 r''' - The data operation does not start until a digital edge is detected. The source of the digital edge is specified with the %property{digital edge start trigger source} property, and the active edge is specified with the %property{digital edge start trigger edge} property. + The data operation does not start until a digital edge is detected. The source of the digital edge is specified with the digital_edge_start_trigger_source property, and the active edge is specified with the digital_edge_start_trigger_edge property. ''' DIGITAL_LEVEL = 8000 r''' - The data operation does not start until the digital level is detected. The source of the digital level is specified in the %property{digital level script trigger source} property, and the active level is specified in the %property{digital level script trigger active level} property. + The data operation does not start until the digital level is detected. The source of the digital level is specified in the digital_level_script_trigger_source property, and the active level is specified in the digital_level_script_trigger_active_level property. ''' SOFTWARE = 2 r''' - The data operation does not start until a software trigger occurs. You can create a software event by calling the %method{send software edge trigger} method. + The data operation does not start until a software trigger occurs. You can create a software event by calling the send_software_edge_trigger method. ''' @@ -1601,41 +780,6 @@ class Signal(Enum): ''' -class SignalIdentifier(Enum): - MARKER_EVENT0 = 'marker0' - r''' - Specifies Marker 0. - ''' - MARKER_EVENT1 = 'marker1' - r''' - Specifies Marker 1. - ''' - MARKER_EVENT2 = 'marker2' - r''' - Specifies Marker 2. - ''' - MARKER_EVENT3 = 'marker3' - r''' - Specifies Marker 3. - ''' - SCRIPT_TRIGGER0 = 'scriptTrigger0' - r''' - Specifies Script Trigger 0. - ''' - SCRIPT_TRIGGER1 = 'scriptTrigger1' - r''' - Specifies Script Trigger 1. - ''' - SCRIPT_TRIGGER2 = 'scriptTrigger2' - r''' - Specifies Script Trigger 2. - ''' - SCRIPT_TRIGGER3 = 'scriptTrigger3' - r''' - Specifies Script Trigger 3. - ''' - - class SoftwareTriggerType(Enum): SCRIPT = 1 r''' @@ -1669,196 +813,6 @@ class StartTrigDigEdgeEdge(Enum): ''' -class StartTrigDigEdgeSource(Enum): - PFI0 = 'PFI0' - r''' - The trigger is received on PFI 0. - ''' - PFI1 = 'PFI1' - r''' - The trigger is received on PFI 1. - ''' - PFI2 = 'PFI2' - r''' - The trigger is received on PFI 2. - ''' - PFI3 = 'PFI3' - r''' - The trigger is received on PFI 3. - ''' - PXI_TRIG0 = 'PXI_Trig0' - r''' - The trigger is received on PXI trigger line 0. - ''' - PXI_TRIG1 = 'PXI_Trig1' - r''' - The trigger is received on PXI trigger line 1. - ''' - PXI_TRIG2 = 'PXI_Trig2' - r''' - The trigger is received on PXI trigger line 2. - ''' - PXI_TRIG3 = 'PXI_Trig3' - r''' - The trigger is received on PXI trigger line 3. - ''' - PXI_TRIG4 = 'PXI_Trig4' - r''' - The trigger is received on PXI trigger line 4. - ''' - PXI_TRIG5 = 'PXI_Trig5' - r''' - The trigger is received on PXI trigger line 5. - ''' - PXI_TRIG6 = 'PXI_Trig6' - r''' - The trigger is received on PXI trigger line 6. - ''' - PXI_TRIG7 = 'PXI_Trig7' - r''' - The trigger is received on PXI trigger line 7. - ''' - PXI_STAR = 'PXI_Star' - r''' - The trigger is received on the PXI star trigger line. This value is not valid on the PXIe-5644/5645/5646. - ''' - PXIE_DSTARB = 'PXIe_DStarB' - r''' - The trigger is received on the PXI DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. - ''' - TRIG_IN = 'TrigIn' - r''' - The trigger is received on the TRIG IN/OUT terminal. This value is valid on only the PXIe-5654/5654 with PXIe-5696. - ''' - DIO0 = 'DIO/PFI0' - r''' - The trigger is received on PFI0 from the front panel DIO terminal. - ''' - DIO1 = 'DIO/PFI1' - r''' - The trigger is received on PFI1 from the front panel DIO terminal. - ''' - DIO2 = 'DIO/PFI2' - r''' - The trigger is received on PFI2 from the front panel DIO terminal. - ''' - DIO3 = 'DIO/PFI3' - r''' - The trigger is received on PFI3 from the front panel DIO terminal. - ''' - DIO4 = 'DIO/PFI4' - r''' - The trigger is received on PFI4 from the front panel DIO terminal. - ''' - DIO5 = 'DIO/PFI5' - r''' - The trigger is received on PFI5 from the front panel DIO terminal. - ''' - DIO6 = 'DIO/PFI6' - r''' - The trigger is received on PFI6 from the front panel DIO terminal. - ''' - DIO7 = 'DIO/PFI7' - r''' - The trigger is received on PFI7 from the front panel DIO terminal. - ''' - SYNC_START_TRIGGER = 'Sync_Start' - r''' - The trigger is received on the Sync Start trigger line. This value is valid on only the PXIe-5644/5645/5646. - ''' - - -class StartTrigExportOutputTerm(Enum): - DO_NOT_EXPORT = '' - r''' - The signal is not exported. - ''' - PFI0 = 'PFI0' - r''' - The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. - ''' - PFI1 = 'PFI1' - r''' - The signal is exported to the PFI 1 connector. - ''' - PFI4 = 'PFI4' - r''' - The signal is exported to the PFI 4 connector. - ''' - PFI5 = 'PFI5' - r''' - The signal is exported to the PFI 5 connector. - ''' - PXI_TRIG0 = 'PXI_Trig0' - r''' - The signal is exported to the PXI trigger line 0. - ''' - PXI_TRIG1 = 'PXI_Trig1' - r''' - The signal is exported to the PXI trigger line 1. - ''' - PXI_TRIG2 = 'PXI_Trig2' - r''' - The signal is exported to the PXI trigger line 2. - ''' - PXI_TRIG3 = 'PXI_Trig3' - r''' - The signal is exported to the PXI trigger line 3. - ''' - PXI_TRIG4 = 'PXI_Trig4' - r''' - The signal is exported to the PXI trigger line 4. - ''' - PXI_TRIG5 = 'PXI_Trig5' - r''' - The signal is exported to the PXI trigger line 5. - ''' - PXI_TRIG6 = 'PXI_Trig6' - r''' - The signal is exported to the PXI trigger line 6. - ''' - PXIE_DSTARC = 'PXIe_DStarC' - r''' - The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. - ''' - TRIG_OUT = 'TrigOut' - r''' - The signal is exported to the TRIG IN/OUT terminal. This value is valid on only the PXIe-5654/5654 with PXIe-5696. - ''' - DIO0 = 'DIO/PFI0' - r''' - The trigger is received on PFI0 from the front panel DIO terminal. - ''' - DIO1 = 'DIO/PFI1' - r''' - The trigger is received on PFI1 from the front panel DIO terminal. - ''' - DIO2 = 'DIO/PFI2' - r''' - The trigger is received on PFI2 from the front panel DIO terminal. - ''' - DIO3 = 'DIO/PFI3' - r''' - The trigger is received on PFI3 from the front panel DIO terminal. - ''' - DIO4 = 'DIO/PFI4' - r''' - The trigger is received on PFI4 from the front panel DIO terminal. - ''' - DIO5 = 'DIO/PFI5' - r''' - The trigger is received on PFI5 from the front panel DIO terminal. - ''' - DIO6 = 'DIO/PFI6' - r''' - The trigger is received on PFI6 from the front panel DIO terminal. - ''' - DIO7 = 'DIO/PFI7' - r''' - The trigger is received on PFI7 from the front panel DIO terminal. - ''' - - class StartTrigType(Enum): NONE = 0 r''' @@ -1866,142 +820,30 @@ class StartTrigType(Enum): ''' DIGITAL_EDGE = 1 r''' - The data operation does not start until a digital edge is detected. The source of the digital edge is specified with the %property{digital edge start trigger source} property, and the active edge is specified in the %property{digital edge start trigger edge} property. + The data operation does not start until a digital edge is detected. The source of the digital edge is specified with the digital_edge_start_trigger_source property, and the active edge is specified in the digital_edge_start_trigger_edge property. ''' SOFTWARE = 2 r''' - The data operation does not start until a software event occurs. You may create a software trigger by calling the %method{send software edge trigger} method. + The data operation does not start until a software event occurs. You may create a software trigger by calling the send_software_edge_trigger method. ''' P2P_ENDPOINT_FULLNESS = 3 r''' - The data operation does not start until the endpoint reaches the threshold specified in the %property{p2p endpoint fullness start trigger level} property. - ''' - - -class StartedEventExportOutputTerm(Enum): - DO_NOT_EXPORT = '' - r''' - The signal is not exported. - ''' - PFI0 = 'PFI0' - r''' - The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. - ''' - PFI1 = 'PFI1' - r''' - The signal is exported to the PFI 1 connector. - ''' - PFI4 = 'PFI4' - r''' - The signal is exported to the PFI 4 connector. - ''' - PFI5 = 'PFI5' - r''' - The signal is exported to the PFI 5 connector. - ''' - PXI_TRIG0 = 'PXI_Trig0' - r''' - The signal is exported to the PXI trigger line 0. - ''' - PXI_TRIG1 = 'PXI_Trig1' - r''' - The signal is exported to the PXI trigger line 1. - ''' - PXI_TRIG2 = 'PXI_Trig2' - r''' - The signal is exported to the PXI trigger line 2. - ''' - PXI_TRIG3 = 'PXI_Trig3' - r''' - The signal is exported to the PXI trigger line 3. - ''' - PXI_TRIG4 = 'PXI_Trig4' - r''' - The signal is exported to the PXI trigger line 4. - ''' - PXI_TRIG5 = 'PXI_Trig5' - r''' - The signal is exported to the PXI trigger line 5. - ''' - PXI_TRIG6 = 'PXI_Trig6' - r''' - The signal is exported to the PXI trigger line 6. - ''' - PXIE_DSTARC = 'PXIe_DStarC' - r''' - The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. - ''' - DIO0 = 'DIO/PFI0' - r''' - The trigger is received on PFI0 from the front panel DIO terminal. - ''' - DIO1 = 'DIO/PFI1' - r''' - The trigger is received on PFI1 from the front panel DIO terminal. - ''' - DIO2 = 'DIO/PFI2' - r''' - The trigger is received on PFI2 from the front panel DIO terminal. - ''' - DIO3 = 'DIO/PFI3' - r''' - The trigger is received on PFI3 from the front panel DIO terminal. - ''' - DIO4 = 'DIO/PFI4' - r''' - The trigger is received on PFI4 from the front panel DIO terminal. - ''' - DIO5 = 'DIO/PFI5' - r''' - The trigger is received on PFI5 from the front panel DIO terminal. - ''' - DIO6 = 'DIO/PFI6' - r''' - The trigger is received on PFI6 from the front panel DIO terminal. - ''' - DIO7 = 'DIO/PFI7' - r''' - The trigger is received on PFI7 from the front panel DIO terminal. - ''' - - -class TriggerIdentifier(Enum): - SCRIPT_TRIGGER0 = 'scriptTrigger0' - r''' - Specifies Script Trigger 0. - ''' - SCRIPT_TRIGGER1 = 'scriptTrigger1' - r''' - Specifies Script Trigger 1. - ''' - SCRIPT_TRIGGER2 = 'scriptTrigger2' - r''' - Specifies Script Trigger 2. - ''' - SCRIPT_TRIGGER3 = 'scriptTrigger3' - r''' - Specifies Script Trigger 3. - ''' - NONE_EMPTY_STRING = '' - r''' - None (no signal to export) + The data operation does not start until the endpoint reaches the threshold specified in the p2p_endpoint_fullness_start_trigger_level property. ''' class UpconverterFrequencyOffsetMode(Enum): AUTO = -1 r''' - NI-RFSG places the upconverter center frequency outside of the signal bandwidth if the %property{signal bandwidth} property has been set and can be avoided. + NI-RFSG places the upconverter center frequency outside of the signal bandwidth if the signal_bandwidth property has been set and can be avoided. ''' - AUTOMATIC = -1 ENABLE = 1 r''' - NI-RFSG places the upconverter center frequency outside of the signal bandwidth if the %property{signal bandwidth} property has been set and can be avoided. NI-RFSG returns an error if the %property{signal bandwidth} property has not been set, or if the signal bandwidth is too large. + NI-RFSG places the upconverter center frequency outside of the signal bandwidth if the signal_bandwidth property has been set and can be avoided. NI-RFSG returns an error if the signal_bandwidth property has not been set, or if the signal bandwidth is too large. ''' - SCRIPT_TRIGGER = 1 USER_DEFINED = 5001 r''' - NI-RFSG uses the offset that you specified with the %property{upconverter frequency offset} or %property{upconverter center frequency} properties. + NI-RFSG uses the offset that you specified with the upconverter_frequency_offset or upconverter_center_frequency properties. ''' diff --git a/generated/nirfsg/nirfsg/session.py b/generated/nirfsg/nirfsg/session.py index c81c41bad..645ea429b 100644 --- a/generated/nirfsg/nirfsg/session.py +++ b/generated/nirfsg/nirfsg/session.py @@ -633,14 +633,14 @@ class _SessionBase(object): **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 ''' - arb_sample_clock_source = _attributes.AttributeEnum(_attributes.AttributeViString, enums.ArbSampleClockSource, 1150030) - '''Type: enums.ArbSampleClockSource + arb_sample_clock_source = _attributes.AttributeViString(1150030) + '''Type: str Specifies the Sample Clock source for the device. To set this property, the NI-RFSG device must be in the Configuration state. - PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: ArbSampleClockSource.ONBOARD_CLOCK is the only supported value for this device. + PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: NIRFSG_VAL_ONBOARD_CLOCK_STR is the only supported value for this device. - **Default Value:** ArbSampleClockSource.ONBOARD_CLOCK + **Default Value:** NIRFSG_VAL_ONBOARD_CLOCK_STR **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -648,15 +648,15 @@ class _SessionBase(object): `Timing Configurations `_ - **Defined Values**: + **Possible Values**: - +------------------------------------+--------------+---------------------------------------------------------------+ - | Name | Value | Description | - +====================================+==============+===============================================================+ - | ArbSampleClockSource.CLK_IN | ClkIn | Uses the external clock as the Sample Clock source. | - +------------------------------------+--------------+---------------------------------------------------------------+ - | ArbSampleClockSource.ONBOARD_CLOCK | OnboardClock | Uses the AWG module onboard clock as the Sample Clock source. | - +------------------------------------+--------------+---------------------------------------------------------------+ + +----------------+---------------------------------------------------------------+ + | Possible Value | Description | + +================+===============================================================+ + | ClkIn | Uses the external clock as the Sample Clock source. | + +----------------+---------------------------------------------------------------+ + | OnboardClock | Uses the AWG module onboard clock as the Sample Clock source. | + +----------------+---------------------------------------------------------------+ Note: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. @@ -1109,27 +1109,27 @@ class _SessionBase(object): To use this property, you must use the channelName parameter of the _set_attribute_vi_int32 method to specify the name of the port to configure for de-embedding. - If you set this property to DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_SCALAR or DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_VECTOR, NI-RFSG adjusts the instrument settings and the returned data to remove the effects of the external network between the instrument and the DUT. + If you set this property to DeembeddingTypeAttrVals.SCALAR or DeembeddingTypeAttrVals.VECTOR, NI-RFSG adjusts the instrument settings and the returned data to remove the effects of the external network between the instrument and the DUT. - **Default Value**: DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_SCALAR + **Default Value**: DeembeddingTypeAttrVals.SCALAR - **Valid Values for PXIe-5830/5832/5840/5841/5842/5860** : DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_SCALAR or DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_NONE + **Valid Values for PXIe-5830/5832/5840/5841/5842/5860** : DeembeddingTypeAttrVals.SCALAR or DeembeddingTypeAttrVals.NONE - **Valid Values for PXIe-5831** DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_SCALAR, DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_VECTOR, or DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_NONE. DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_VECTOR is only supported for TRX Ports in a Semiconductor Test System (STS). + **Valid Values for PXIe-5831** DeembeddingTypeAttrVals.SCALAR, DeembeddingTypeAttrVals.VECTOR, or DeembeddingTypeAttrVals.NONE. DeembeddingTypeAttrVals.VECTOR is only supported for TRX Ports in a Semiconductor Test System (STS). **Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860 **Defined Values**: - +-------------------------------------------------+----------------+------------------------------------------------------------------------+ - | Name | Value | Description | - +=================================================+================+========================================================================+ - | DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_NONE | 25000 (0x61a8) | De-embedding is not applied to the measurement. | - +-------------------------------------------------+----------------+------------------------------------------------------------------------+ - | DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_SCALAR | 25001 (0x61a9) | De-embeds the measurement using only the gain term. | - +-------------------------------------------------+----------------+------------------------------------------------------------------------+ - | DeembeddingTypeAttrVals.DEEMBEDDING_TYPE_VECTOR | 25002 (0x61aa) | De-embeds the measurement using the gain term and the reflection term. | - +-------------------------------------------------+----------------+------------------------------------------------------------------------+ + +--------------------------------+----------------+------------------------------------------------------------------------+ + | Name | Value | Description | + +================================+================+========================================================================+ + | DeembeddingTypeAttrVals.NONE | 25000 (0x61a8) | De-embedding is not applied to the measurement. | + +--------------------------------+----------------+------------------------------------------------------------------------+ + | DeembeddingTypeAttrVals.SCALAR | 25001 (0x61a9) | De-embeds the measurement using only the gain term. | + +--------------------------------+----------------+------------------------------------------------------------------------+ + | DeembeddingTypeAttrVals.VECTOR | 25002 (0x61aa) | De-embeds the measurement using the gain term and the reflection term. | + +--------------------------------+----------------+------------------------------------------------------------------------+ Tip: This property can be set/get on specific deembedding_port within your :py:class:`nirfsg.Session` instance. @@ -1245,8 +1245,8 @@ class _SessionBase(object): Example: :py:attr:`my_session.digital_edge_script_trigger_edge` ''' - digital_edge_script_trigger_source = _attributes.AttributeEnum(_attributes.AttributeViString, enums.ScriptTrigDigEdgeSource, 1150020) - '''Type: enums.ScriptTrigDigEdgeSource + digital_edge_script_trigger_source = _attributes.AttributeViString(1150020) + '''Type: str Specifies the source terminal for the Script Trigger. This property is used when the script_trigger_type property is set to digital edge. To set this property, the NI-RFSG device must be in the Configuration state. @@ -1264,62 +1264,59 @@ class _SessionBase(object): - configure_digital_edge_script_trigger - **Defined Values**: - - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +=============================================+=============+=========================================================================================================================================+ - | ScriptTrigDigEdgeSource.PFI0 | PFI0 | The trigger is received on PFI 0. | - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigEdgeSource.PFI1 | PFI1 | The trigger is received on PFI 1. | - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigEdgeSource.PFI2 | PFI2 | The trigger is received on PFI 2. | - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigEdgeSource.PFI3 | PFI3 | The trigger is received on PFI 3. | - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigEdgeSource.PXI_STAR | PXI_Star | The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646. | - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigEdgeSource.PXI_TRIG0 | PXI_Trig0 | The trigger is received on PXI trigger line 0. | - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigEdgeSource.PXI_TRIG1 | PXI_Trig1 | The trigger is received on PXI trigger line 1. | - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigEdgeSource.PXI_TRIG2 | PXI_Trig2 | The trigger is received on PXI trigger line 2. | - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigEdgeSource.PXI_TRIG3 | PXI_Trig3 | The trigger is received on PXI trigger line 3. | - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigEdgeSource.PXI_TRIG4 | PXI_Trig4 | The trigger is received on PXI trigger line 4. | - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigEdgeSource.PXI_TRIG5 | PXI_Trig5 | The trigger is received on PXI trigger line 5. | - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigEdgeSource.PXI_TRIG6 | PXI_Trig6 | The trigger is received on PXI trigger line 6. | - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigEdgeSource.PXI_TRIG7 | PXI_Trig7 | The trigger is received on PXI trigger line 7. | - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigEdgeSource.PXIE_DSTARB | PXIe_DStarB | The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. | - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigEdgeSource.PULSE_IN | PulseIn | The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842. | - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigEdgeSource.DIO0 | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigEdgeSource.DIO1 | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigEdgeSource.DIO2 | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigEdgeSource.DIO3 | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigEdgeSource.DIO4 | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigEdgeSource.DIO5 | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigEdgeSource.DIO6 | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigEdgeSource.DIO7 | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigEdgeSource.SYNC_SCRIPT_TRIGGER | Sync_Script | The trigger is received on the Sync Script trigger line. This value is valid on only the PXIe-5644/5645/5646. | - +---------------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - - Note: - One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. + **Possible Values**: + + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | Possible Value | Description | + +================+=========================================================================================================================================+ + | PFI0 | The trigger is received on PFI 0. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI1 | The trigger is received on PFI 1. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI2 | The trigger is received on PFI 2. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI3 | The trigger is received on PFI 3. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Star | The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig7 | The trigger is received on PXI trigger line 7. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXIe_DStarB | The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PulseIn | The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | Sync_Script | The trigger is received on the Sync Script trigger line. This value is valid on only the PXIe-5644/5645/5646. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ Tip: This property can be set/get on specific script_triggers within your :py:class:`nirfsg.Session` instance. @@ -1365,8 +1362,8 @@ 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. ''' - digital_edge_start_trigger_source = _attributes.AttributeEnum(_attributes.AttributeViString, enums.StartTrigDigEdgeSource, 1150002) - '''Type: enums.StartTrigDigEdgeSource + digital_edge_start_trigger_source = _attributes.AttributeViString(1150002) + '''Type: str Specifies the source terminal for the Start Trigger. This property is used when the start_trigger_type property is set to digital edge. The digital_edge_start_trigger_source property is not case-sensitive. To set the digital_edge_start_trigger_source property, the NI-RFSG device must be in the Configuration state. @@ -1386,62 +1383,59 @@ class _SessionBase(object): - configure_digital_edge_start_trigger - **Defined Values**: - - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +=============================================+=============+========================================================================================================================================+ - | StartTrigDigEdgeSource.PFI0 | PFI0 | The trigger is received on PFI 0. | - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigDigEdgeSource.PFI1 | PFI1 | The trigger is received on PFI 1. | - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigDigEdgeSource.PFI2 | PFI2 | The trigger is received on PFI 2. | - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigDigEdgeSource.PFI3 | PFI3 | The trigger is received on PFI 3. | - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigDigEdgeSource.PXI_STAR | PXI_Star | The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646. | - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigDigEdgeSource.PXI_TRIG0 | PXI_Trig0 | The trigger is received on PXI trigger line 0. | - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigDigEdgeSource.PXI_TRIG1 | PXI_Trig1 | The trigger is received on PXI trigger line 1. | - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigDigEdgeSource.PXI_TRIG2 | PXI_Trig2 | The trigger is received on PXI trigger line 2. | - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigDigEdgeSource.PXI_TRIG3 | PXI_Trig3 | The trigger is received on PXI trigger line 3. | - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigDigEdgeSource.PXI_TRIG4 | PXI_Trig4 | The trigger is received on PXI trigger line 4. | - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigDigEdgeSource.PXI_TRIG5 | PXI_Trig5 | The trigger is received on PXI trigger line 5. | - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigDigEdgeSource.PXI_TRIG6 | PXI_Trig6 | The trigger is received on PXI trigger line 6. | - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigDigEdgeSource.PXI_TRIG7 | PXI_Trig7 | The trigger is received on PXI trigger line 7. | - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigDigEdgeSource.PXIE_DSTARB | PXIe_DStarB | The trigger is received on the PXI DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. | - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigDigEdgeSource.TRIG_IN | TrigIn | The trigger is received on the TRIG IN/OUT terminal. This value is valid on only the PXIe-5654/5654 with PXIe-5696. | - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigDigEdgeSource.DIO0 | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigDigEdgeSource.DIO1 | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigDigEdgeSource.DIO2 | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigDigEdgeSource.DIO3 | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigDigEdgeSource.DIO4 | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigDigEdgeSource.DIO5 | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigDigEdgeSource.DIO6 | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigDigEdgeSource.DIO7 | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigEdgeSource.SYNC_SCRIPT_TRIGGER | Sync_Script | The trigger is received on the Sync Script trigger line. This value is valid on only the PXIe-5644/5645/5646. | - +---------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - - Note: - One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. + **Possible Values**: + + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Possible Value | Description | + +================+========================================================================================================================================+ + | PFI0 | The trigger is received on PFI 0. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI1 | The trigger is received on PFI 1. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI2 | The trigger is received on PFI 2. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI3 | The trigger is received on PFI 3. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Star | The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig7 | The trigger is received on PXI trigger line 7. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXIe_DStarB | The trigger is received on the PXI DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | TrigIn | The trigger is received on the TRIG IN/OUT terminal. This value is valid on only the PXIe-5654/5654 with PXIe-5696. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Sync_Script | The trigger is received on the Sync Script trigger line. This value is valid on only the PXIe-5644/5645/5646. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ ''' digital_equalization_enabled = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.DigitalEqualizationEnabled, 1150012) '''Type: enums.DigitalEqualizationEnabled @@ -1518,8 +1512,8 @@ class _SessionBase(object): Example: :py:attr:`my_session.digital_level_script_trigger_active_level` ''' - digital_level_script_trigger_source = _attributes.AttributeEnum(_attributes.AttributeViString, enums.ScriptTrigDigLevelSource, 1150054) - '''Type: enums.ScriptTrigDigLevelSource + digital_level_script_trigger_source = _attributes.AttributeViString(1150054) + '''Type: str Specifies the source terminal for the Script Trigger. This property is used when the script_trigger_type property is set to ScriptTrigType.DIGITAL_LEVEL. The digital_level_script_trigger_source property is not case-sensitive. @@ -1535,60 +1529,57 @@ class _SessionBase(object): `PXI Trigger Lines `_ - **Defined Values**: - - +--------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +======================================+=============+=========================================================================================================================================+ - | ScriptTrigDigLevelSource.PFI0 | PFI0 | The trigger is received on PFI 0. | - +--------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigLevelSource.PFI1 | PFI1 | The trigger is received on PFI 1. | - +--------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigLevelSource.PFI2 | PFI2 | The trigger is received on PFI 2. | - +--------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigLevelSource.PFI3 | PFI3 | The trigger is received on PFI 3. | - +--------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigLevelSource.PXI_STAR | PXI_Star | The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646. | - +--------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigLevelSource.PXI_TRIG0 | PXI_Trig0 | The trigger is received on PXI trigger line 0. | - +--------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigLevelSource.PXI_TRIG1 | PXI_Trig1 | The trigger is received on PXI trigger line 1. | - +--------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigLevelSource.PXI_TRIG2 | PXI_Trig2 | The trigger is received on PXI trigger line 2. | - +--------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigLevelSource.PXI_TRIG3 | PXI_Trig3 | The trigger is received on PXI trigger line 3. | - +--------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigLevelSource.PXI_TRIG4 | PXI_Trig4 | The trigger is received on PXI trigger line 4. | - +--------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigLevelSource.PXI_TRIG5 | PXI_Trig5 | The trigger is received on PXI trigger line 5. | - +--------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigLevelSource.PXI_TRIG6 | PXI_Trig6 | The trigger is received on PXI trigger line 6. | - +--------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigLevelSource.PXI_TRIG7 | PXI_Trig7 | The trigger is received on PXI trigger line 7. | - +--------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigLevelSource.PXIE_DSTARB | PXIe_DStarB | The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. | - +--------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigLevelSource.PULSE_IN | PulseIn | The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842. | - +--------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigLevelSource.DIO0 | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | - +--------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigLevelSource.DIO1 | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | - +--------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigLevelSource.DIO2 | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | - +--------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigLevelSource.DIO3 | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | - +--------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigLevelSource.DIO4 | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | - +--------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigLevelSource.DIO5 | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | - +--------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigLevelSource.DIO6 | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | - +--------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigDigLevelSource.DIO7 | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | - +--------------------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - - Note: - One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. + **Possible Values**: + + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | Possible Value | Description | + +================+=========================================================================================================================================+ + | PFI0 | The trigger is received on PFI 0. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI1 | The trigger is received on PFI 1. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI2 | The trigger is received on PFI 2. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI3 | The trigger is received on PFI 3. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Star | The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig7 | The trigger is received on PXI trigger line 7. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PXIe_DStarB | The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | PulseIn | The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ Tip: This property can be set/get on specific script_triggers within your :py:class:`nirfsg.Session` instance. @@ -1796,7 +1787,7 @@ class _SessionBase(object): **High-Level Methods**: - - GetTerminalName + - get_terminal_name ''' events_delay = _attributes.AttributeViReal64TimeDeltaSeconds(1150154) '''Type: hightime.timedelta, datetime.timedelta, or float in seconds @@ -1823,8 +1814,8 @@ class _SessionBase(object): Note: If you decrease the event delay during generation, some markers may be dropped. ''' - exported_configuration_settled_event_output_terminal = _attributes.AttributeEnum(_attributes.AttributeViString, enums.ConfigurationSettledEventExportOutputTerm, 1150129) - '''Type: enums.ConfigurationSettledEventExportOutputTerm + exported_configuration_settled_event_output_terminal = _attributes.AttributeViString(1150129) + '''Type: str Specifies the destination terminal for exporting the Configuration Settled event. To set this property, the NI-RFSG device must be in the Configuration state. @@ -1840,37 +1831,34 @@ class _SessionBase(object): `PXI Trigger Lines `_ - **Defined Values**: - - +---------------------------------------------------------+-------------+--------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +=========================================================+=============+====================================================================================================================+ - | ConfigurationSettledEventExportOutputTerm.DO_NOT_EXPORT | | The signal is not exported. | - +---------------------------------------------------------+-------------+--------------------------------------------------------------------------------------------------------------------+ - | ConfigurationSettledEventExportOutputTerm.PXI_TRIG0 | PXI_Trig0 | The trigger is received on PXI trigger line 0. | - +---------------------------------------------------------+-------------+--------------------------------------------------------------------------------------------------------------------+ - | ConfigurationSettledEventExportOutputTerm.PXI_TRIG1 | PXI_Trig1 | The trigger is received on PXI trigger line 1. | - +---------------------------------------------------------+-------------+--------------------------------------------------------------------------------------------------------------------+ - | ConfigurationSettledEventExportOutputTerm.PXI_TRIG2 | PXI_Trig2 | The trigger is received on PXI trigger line 2. | - +---------------------------------------------------------+-------------+--------------------------------------------------------------------------------------------------------------------+ - | ConfigurationSettledEventExportOutputTerm.PXI_TRIG3 | PXI_Trig3 | The trigger is received on PXI trigger line 3. | - +---------------------------------------------------------+-------------+--------------------------------------------------------------------------------------------------------------------+ - | ConfigurationSettledEventExportOutputTerm.PXI_TRIG4 | PXI_Trig4 | The trigger is received on PXI trigger line 4. | - +---------------------------------------------------------+-------------+--------------------------------------------------------------------------------------------------------------------+ - | ConfigurationSettledEventExportOutputTerm.PXI_TRIG5 | PXI_Trig5 | The trigger is received on PXI trigger line 5. | - +---------------------------------------------------------+-------------+--------------------------------------------------------------------------------------------------------------------+ - | ConfigurationSettledEventExportOutputTerm.PXI_TRIG6 | PXI_Trig6 | The trigger is received on PXI trigger line 6. | - +---------------------------------------------------------+-------------+--------------------------------------------------------------------------------------------------------------------+ - | ConfigurationSettledEventExportOutputTerm.PXIE_DSTARC | PXIe_DStarC | The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5840/5841/5842. | - +---------------------------------------------------------+-------------+--------------------------------------------------------------------------------------------------------------------+ - | ConfigurationSettledEventExportOutputTerm.TRIG_OUT | TrigOut | TRIG IN/OUT terminal. | - +---------------------------------------------------------+-------------+--------------------------------------------------------------------------------------------------------------------+ - - Note: - One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. - ''' - exported_done_event_output_terminal = _attributes.AttributeEnum(_attributes.AttributeViString, enums.DoneEventExportOutputTerm, 1150063) - '''Type: enums.DoneEventExportOutputTerm + **Possible Values**: + + +----------------+--------------------------------------------------------------------------------------------------------------------+ + | Possible Value | Description | + +================+====================================================================================================================+ + | empty | The signal is not exported. | + +----------------+--------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + +----------------+--------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + +----------------+--------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + +----------------+--------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + +----------------+--------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + +----------------+--------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + +----------------+--------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + +----------------+--------------------------------------------------------------------------------------------------------------------+ + | PXIe_DStarC | The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5840/5841/5842. | + +----------------+--------------------------------------------------------------------------------------------------------------------+ + | TrigOut | TRIG IN/OUT terminal. | + +----------------+--------------------------------------------------------------------------------------------------------------------+ + ''' + exported_done_event_output_terminal = _attributes.AttributeViString(1150063) + '''Type: str Specifies the destination terminal for exporting the Done event. To set this property, the NI-RFSG device must be in the Configuration state. @@ -1890,59 +1878,56 @@ class _SessionBase(object): - export_signal - **Defined Values**: - - +-----------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +=========================================+=============+=================================================================================================================================+ - | DoneEventExportOutputTerm.DO_NOT_EXPORT | | The signal is not exported. | - +-----------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | DoneEventExportOutputTerm.PFI0 | PFI0 | The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. | - +-----------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | DoneEventExportOutputTerm.PFI1 | PFI1 | The signal is exported to the PFI 1 connector. | - +-----------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | DoneEventExportOutputTerm.PFI4 | PFI4 | The signal is exported to the PFI 4 connector. | - +-----------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | DoneEventExportOutputTerm.PFI5 | PFI5 | The signal is exported to the PFI 5 connector. | - +-----------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | DoneEventExportOutputTerm.PXI_TRIG0 | PXI_Trig0 | The trigger is received on PXI trigger line 0. | - +-----------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | DoneEventExportOutputTerm.PXI_TRIG1 | PXI_Trig1 | The trigger is received on PXI trigger line 1. | - +-----------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | DoneEventExportOutputTerm.PXI_TRIG2 | PXI_Trig2 | The trigger is received on PXI trigger line 2. | - +-----------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | DoneEventExportOutputTerm.PXI_TRIG3 | PXI_Trig3 | The trigger is received on PXI trigger line 3. | - +-----------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | DoneEventExportOutputTerm.PXI_TRIG4 | PXI_Trig4 | The trigger is received on PXI trigger line 4. | - +-----------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | DoneEventExportOutputTerm.PXI_TRIG5 | PXI_Trig5 | The trigger is received on PXI trigger line 5. | - +-----------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | DoneEventExportOutputTerm.PXI_TRIG6 | PXI_Trig6 | The trigger is received on PXI trigger line 6. | - +-----------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | DoneEventExportOutputTerm.PXIE_DSTARC | PXIe_DStarC | The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841. | - +-----------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | DoneEventExportOutputTerm.DIO0 | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | - +-----------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | DoneEventExportOutputTerm.DIO1 | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | - +-----------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | DoneEventExportOutputTerm.DIO2 | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | - +-----------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | DoneEventExportOutputTerm.DIO3 | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | - +-----------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | DoneEventExportOutputTerm.DIO4 | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | - +-----------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | DoneEventExportOutputTerm.DIO5 | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | - +-----------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | DoneEventExportOutputTerm.DIO6 | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | - +-----------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | DoneEventExportOutputTerm.DIO7 | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | - +-----------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - - Note: - One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. - ''' - exported_marker_event_output_terminal = _attributes.AttributeEnum(_attributes.AttributeViString, enums.MarkerEventExportOutputTerm, 1150064) - '''Type: enums.MarkerEventExportOutputTerm + **Possible Values**: + + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | Posible Value | Description | + +===============+=================================================================================================================================+ + | empty | The signal is not exported. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PFI0 | The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PFI1 | The signal is exported to the PFI 1 connector. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PFI4 | The signal is exported to the PFI 4 connector. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PFI5 | The signal is exported to the PFI 5 connector. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXIe_DStarC | The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | + +---------------+---------------------------------------------------------------------------------------------------------------------------------+ + ''' + exported_marker_event_output_terminal = _attributes.AttributeViString(1150064) + '''Type: str Specifies the destination terminal for exporting the Marker Event. To set this property, the NI-RFSG device must be in the Configuration state. @@ -1960,56 +1945,53 @@ class _SessionBase(object): - export_signal - **Defined Values**: - - +-------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +===========================================+=============+=================================================================================================================================+ - | MarkerEventExportOutputTerm.DO_NOT_EXPORT | | The signal is not exported. | - +-------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | MarkerEventExportOutputTerm.PFI0 | PFI0 | The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. | - +-------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | MarkerEventExportOutputTerm.PFI1 | PFI1 | The signal is exported to the PFI 1 connector. | - +-------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | MarkerEventExportOutputTerm.PFI4 | PFI4 | The signal is exported to the PFI 4 connector. | - +-------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | MarkerEventExportOutputTerm.PFI5 | PFI5 | The signal is exported to the PFI 5 connector. | - +-------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | MarkerEventExportOutputTerm.PXI_TRIG0 | PXI_Trig0 | The trigger is received on PXI trigger line 0. | - +-------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | MarkerEventExportOutputTerm.PXI_TRIG1 | PXI_Trig1 | The trigger is received on PXI trigger line 1. | - +-------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | MarkerEventExportOutputTerm.PXI_TRIG2 | PXI_Trig2 | The trigger is received on PXI trigger line 2. | - +-------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | MarkerEventExportOutputTerm.PXI_TRIG3 | PXI_Trig3 | The trigger is received on PXI trigger line 3. | - +-------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | MarkerEventExportOutputTerm.PXI_TRIG4 | PXI_Trig4 | The trigger is received on PXI trigger line 4. | - +-------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | MarkerEventExportOutputTerm.PXI_TRIG5 | PXI_Trig5 | The trigger is received on PXI trigger line 5. | - +-------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | MarkerEventExportOutputTerm.PXI_TRIG6 | PXI_Trig6 | The trigger is received on PXI trigger line 6. | - +-------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | MarkerEventExportOutputTerm.PXIE_DSTARC | PXIe_DStarC | The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841. | - +-------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | MarkerEventExportOutputTerm.DIO0 | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | - +-------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | MarkerEventExportOutputTerm.DIO1 | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | - +-------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | MarkerEventExportOutputTerm.DIO2 | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | - +-------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | MarkerEventExportOutputTerm.DIO3 | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | - +-------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | MarkerEventExportOutputTerm.DIO4 | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | - +-------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | MarkerEventExportOutputTerm.DIO5 | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | - +-------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | MarkerEventExportOutputTerm.DIO6 | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | - +-------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | MarkerEventExportOutputTerm.DIO7 | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | - +-------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - - Note: - One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. + **Possible Values**: + + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | Possible Value | Description | + +================+=================================================================================================================================+ + | empty | The signal is not exported. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PFI0 | The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PFI1 | The signal is exported to the PFI 1 connector. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PFI4 | The signal is exported to the PFI 4 connector. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PFI5 | The signal is exported to the PFI 5 connector. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXIe_DStarC | The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ Tip: This property can be set/get on specific markers within your :py:class:`nirfsg.Session` instance. @@ -2040,66 +2022,66 @@ class _SessionBase(object): | ScriptTrigDigLevelActiveLevel.LOW | 9001 (0x2329) | Trigger when the digital trigger signal is low. | +------------------------------------+---------------+--------------------------------------------------+ ''' - exported_pulse_modulation_event_output_terminal = _attributes.AttributeEnum(_attributes.AttributeViString, enums.PulseModulationOutputTerm, 1150309) - '''Type: enums.PulseModulationOutputTerm + exported_pulse_modulation_event_output_terminal = _attributes.AttributeViString(1150309) + '''Type: str Specifies the destination terminal for exporting the Pulse Modulation Event. The Pulse Modulation Event tracks the RF Envelope when Pulse Modulation is Enabled. If this property is set to a value other than `do not export str`, calling NI-RFSG Commit will cause the output terminal to be pulled to the logic level that is the inverse of `exported pulse modulation event active level`. You can tri-state this terminal by setting this property to `do not export str` or by calling `niRFSG Reset`. To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** PulseModulationOutputTerm.PULSE_OUT + **Default Value:** NIRFSG_VAL_PULSE_OUT_STR **Supported Devices:** PXIe-5842 - **Defined Values**: + **Possible Values**: - +-----------------------------------------+----------+---------------------------------------------------------------------+ - | Name | Value | Description | - +=========================================+==========+=====================================================================+ - | PulseModulationOutputTerm.DO_NOT_EXPORT | | Pulse modulation video signal is not exported. | - +-----------------------------------------+----------+---------------------------------------------------------------------+ - | PulseModulationOutputTerm.PULSE_OUT | PulseOut | Export the pulse modulation video signal on the pulse out terminal. | - +-----------------------------------------+----------+---------------------------------------------------------------------+ + +----------------+---------------------------------------------------------------------+ + | Possible Value | Description | + +================+=====================================================================+ + | | Pulse modulation video signal is not exported. | + +----------------+---------------------------------------------------------------------+ + | PulseOut | Export the pulse modulation video signal on the pulse out terminal. | + +----------------+---------------------------------------------------------------------+ Note: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. ''' - exported_ref_clock_output_terminal = _attributes.AttributeEnum(_attributes.AttributeViString, enums.ReferenceClockExportOutputTerminal, 1150053) - '''Type: enums.ReferenceClockExportOutputTerminal + exported_ref_clock_output_terminal = _attributes.AttributeViString(1150053) + '''Type: str Specifies the destination terminal for exporting the Reference Clock on the RF signal generators. To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** ReferenceClockExportOutputTerminal.DO_NOT_EXPORT + **Possible Values**: - **Supported Devices:** PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + Possible Value: Description - **Related Topics** + "" :The Reference Clock signal is not exported. - `Interconnecting Multiple NI 5673E Modules `_ + RefOut :Exports the Reference Clock signal to the REF OUT connector of the device. - **Defined Values**: + RefOut2 :Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable. - Name (Value): Description + ClkOut :Exports the Reference Clock signal to the CLK OUT connector of the device. - ReferenceClockExportOutputTerminal.DO_NOT_EXPORT () :The Reference Clock signal is not exported. + **Default Value:** NIRFSG_VAL_DO_NOT_EXPORT_STR - ReferenceClockExportOutputTerminal.REF_OUT (RefOut) :Exports the Reference Clock signal to the REF OUT connector of the device. + **Supported Devices:** PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - ReferenceClockExportOutputTerminal.REF_OUT2 (RefOut2) :Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable. + **Related Topics** - ReferenceClockExportOutputTerminal.CLK_OUT (ClkOut) :Exports the Reference Clock signal to the CLK OUT connector of the device. + `Interconnecting Multiple NI 5673E Modules `_ - +--------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | Supported devices | - +==================================================+=========+============================================================================================+=======================================================================================================================================================================+ - | ReferenceClockExportOutputTerminal.CLK_OUT | ClkOut | Exports the Reference Clock signal to the CLK OUT connector of the device. | Supported on PXIe-5673, 5673E | - +--------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ReferenceClockExportOutputTerminal.DO_NOT_EXPORT | | The Reference Clock signal is not exported. | Supported on PXIe-5644/5645/5646, 5820/5830/5831/5832/5840/5841/5842/5860, 5650/5651/5652, 5654, 5673, 5673E, PXIe-5654 with PXIe-5696, PXI-5650/5651/5652 (See Note) | - +--------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ReferenceClockExportOutputTerminal.REF_OUT | RefOut | Exports the Reference Clock signal to the REF OUT connector of the device. | Supported on PXIe-5644/5645/5646, 5820/5830/5831/5832/5840/5841/5842/5860, 5650/5651/5653, 5653, 5654, 5673, 5673E, PXIe-5654 with PXIe-5696, PXI-5650/5651/5653, | - +--------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ReferenceClockExportOutputTerminal.REF_OUT2 | RefOut2 | Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable. | Supported on PXIe-5650/5651/5652, 5654, 5673E, PXIe-5654 with PXIe-5696 | - +--------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Value | Description | Supported devices | + +==============================+=========+============================================================================================+=======================================================================================================================================================================+ + | NIRFSG_VAL_CLK_OUT_STR | ClkOut | Exports the Reference Clock signal to the CLK OUT connector of the device. | Supported on PXIe-5673, 5673E | + +------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | NIRFSG_VAL_DO_NOT_EXPORT_STR | empty | The Reference Clock signal is not exported. | Supported on PXIe-5644/5645/5646, 5820/5830/5831/5832/5840/5841/5842/5860, 5650/5651/5652, 5654, 5673, 5673E, PXIe-5654 with PXIe-5696, PXI-5650/5651/5652 (See Note) | + +------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | NIRFSG_VAL_REF_OUT_STR | RefOut | Exports the Reference Clock signal to the REF OUT connector of the device. | Supported on PXIe-5644/5645/5646, 5820/5830/5831/5832/5840/5841/5842/5860, 5650/5651/5653, 5653, 5654, 5673, 5673E, PXIe-5654 with PXIe-5696, PXI-5650/5651/5653, | + +------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | NIRFSG_VAL_REF_OUT2_STR | RefOut2 | Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable. | Supported on PXIe-5650/5651/5652, 5654, 5673E, PXIe-5654 with PXIe-5696 | + +------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - Note: The ReferenceClockExportOutputTerminal.REF_OUT2 output terminal value is valid for only the PXIe-5650/5651/5652, not the PXI-5650/5651/5652. + Note: The NIRFSG_VAL_REF_OUT2_STR output terminal value is valid for only the PXIe-5650/5651/5652, not the PXI-5650/5651/5652. 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. @@ -2128,8 +2110,8 @@ 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. ''' - exported_script_trigger_output_terminal = _attributes.AttributeEnum(_attributes.AttributeViString, enums.ScriptTrigExportOutputTerm, 1150022) - '''Type: enums.ScriptTrigExportOutputTerm + exported_script_trigger_output_terminal = _attributes.AttributeViString(1150022) + '''Type: str Specifies the destination terminal for exporting the Script Trigger. To set this property, the NI-RFSG device must be in the Configuration state. @@ -2147,56 +2129,53 @@ class _SessionBase(object): - export_signal - **Defined Values**: - - +------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +==========================================+=============+=================================================================================================================================+ - | ScriptTrigExportOutputTerm.DO_NOT_EXPORT | | The signal is not exported. | - +------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigExportOutputTerm.PFI0 | PFI0 | The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. | - +------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigExportOutputTerm.PFI1 | PFI1 | The signal is exported to the PFI 1 connector. | - +------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigExportOutputTerm.PFI4 | PFI4 | The signal is exported to the PFI 4 connector. | - +------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigExportOutputTerm.PFI5 | PFI5 | The signal is exported to the PFI 5 connector. | - +------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigExportOutputTerm.PXI_TRIG0 | PXI_Trig0 | The trigger is received on PXI trigger line 0. | - +------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigExportOutputTerm.PXI_TRIG1 | PXI_Trig1 | The trigger is received on PXI trigger line 1. | - +------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigExportOutputTerm.PXI_TRIG2 | PXI_Trig2 | The trigger is received on PXI trigger line 2. | - +------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigExportOutputTerm.PXI_TRIG3 | PXI_Trig3 | The trigger is received on PXI trigger line 3. | - +------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigExportOutputTerm.PXI_TRIG4 | PXI_Trig4 | The trigger is received on PXI trigger line 4. | - +------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigExportOutputTerm.PXI_TRIG5 | PXI_Trig5 | The trigger is received on PXI trigger line 5. | - +------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigExportOutputTerm.PXI_TRIG6 | PXI_Trig6 | The trigger is received on PXI trigger line 6. | - +------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigExportOutputTerm.PXIE_DSTARC | PXIe_DStarC | The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841. | - +------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigExportOutputTerm.DIO0 | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | - +------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigExportOutputTerm.DIO1 | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | - +------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigExportOutputTerm.DIO2 | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | - +------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigExportOutputTerm.DIO3 | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | - +------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigExportOutputTerm.DIO4 | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | - +------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigExportOutputTerm.DIO5 | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | - +------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigExportOutputTerm.DIO6 | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | - +------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ScriptTrigExportOutputTerm.DIO7 | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | - +------------------------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------+ - - Note: - One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. + **Possible Values**: + + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | Possible Value | Description | + +================+=================================================================================================================================+ + | empty | The signal is not exported. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PFI0 | The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PFI1 | The signal is exported to the PFI 1 connector. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PFI4 | The signal is exported to the PFI 4 connector. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PFI5 | The signal is exported to the PFI 5 connector. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | PXIe_DStarC | The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | + +----------------+---------------------------------------------------------------------------------------------------------------------------------+ Tip: This property can be set/get on specific script_triggers within your :py:class:`nirfsg.Session` instance. @@ -2208,8 +2187,8 @@ class _SessionBase(object): Example: :py:attr:`my_session.exported_script_trigger_output_terminal` ''' - exported_started_event_output_terminal = _attributes.AttributeEnum(_attributes.AttributeViString, enums.StartedEventExportOutputTerm, 1150065) - '''Type: enums.StartedEventExportOutputTerm + exported_started_event_output_terminal = _attributes.AttributeViString(1150065) + '''Type: str Specifies the destination terminal for exporting the Started event. To set this property, the NI-RFSG device must be in the Configuration state. @@ -2227,59 +2206,56 @@ class _SessionBase(object): - export_signal - **Defined Values**: - - +--------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +============================================+=============+========================================================================================================================================+ - | StartedEventExportOutputTerm.DO_NOT_EXPORT | | The signal is not exported. | - +--------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartedEventExportOutputTerm.PFI0 | PFI0 | The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. | - +--------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartedEventExportOutputTerm.PFI1 | PFI1 | The signal is exported to the PFI 1 connector. | - +--------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartedEventExportOutputTerm.PFI4 | PFI4 | The signal is exported to the PFI 4 connector. | - +--------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartedEventExportOutputTerm.PFI5 | PFI5 | The signal is exported to the PFI 5 connector. | - +--------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartedEventExportOutputTerm.PXI_TRIG0 | PXI_Trig0 | The trigger is received on PXI trigger line 0. | - +--------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartedEventExportOutputTerm.PXI_TRIG1 | PXI_Trig1 | The trigger is received on PXI trigger line 1. | - +--------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartedEventExportOutputTerm.PXI_TRIG2 | PXI_Trig2 | The trigger is received on PXI trigger line 2. | - +--------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartedEventExportOutputTerm.PXI_TRIG3 | PXI_Trig3 | The trigger is received on PXI trigger line 3. | - +--------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartedEventExportOutputTerm.PXI_TRIG4 | PXI_Trig4 | The trigger is received on PXI trigger line 4. | - +--------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartedEventExportOutputTerm.PXI_TRIG5 | PXI_Trig5 | The trigger is received on PXI trigger line 5. | - +--------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartedEventExportOutputTerm.PXI_TRIG6 | PXI_Trig6 | The trigger is received on PXI trigger line 6. | - +--------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartedEventExportOutputTerm.PXIE_DSTARC | PXIe_DStarC | The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. | - +--------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartedEventExportOutputTerm.DIO0 | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | - +--------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartedEventExportOutputTerm.DIO1 | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | - +--------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartedEventExportOutputTerm.DIO2 | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | - +--------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartedEventExportOutputTerm.DIO3 | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | - +--------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartedEventExportOutputTerm.DIO4 | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | - +--------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartedEventExportOutputTerm.DIO5 | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | - +--------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartedEventExportOutputTerm.DIO6 | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | - +--------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartedEventExportOutputTerm.DIO7 | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | - +--------------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - - Note: - One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. - ''' - exported_start_trigger_output_terminal = _attributes.AttributeEnum(_attributes.AttributeViString, enums.StartTrigExportOutputTerm, 1150003) - '''Type: enums.StartTrigExportOutputTerm + **Possible Values**: + + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Possible Value | Description | + +================+========================================================================================================================================+ + | empty | The signal is not exported. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI0 | The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI1 | The signal is exported to the PFI 1 connector. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI4 | The signal is exported to the PFI 4 connector. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI5 | The signal is exported to the PFI 5 connector. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXIe_DStarC | The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + ''' + exported_start_trigger_output_terminal = _attributes.AttributeViString(1150003) + '''Type: str Specifies the destination terminal for exporting the Start Trigger. To set this property, the NI-RFSG device must be in the Configuration state. @@ -2295,58 +2271,55 @@ class _SessionBase(object): `PXI Trigger Lines `_ - **Defined Values**: - - +-----------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +=========================================+=============+========================================================================================================================================+ - | StartTrigExportOutputTerm.DO_NOT_EXPORT | | The signal is not exported. | - +-----------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigExportOutputTerm.PFI0 | PFI0 | The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. | - +-----------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigExportOutputTerm.PFI1 | PFI1 | The signal is exported to the PFI 1 connector. | - +-----------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigExportOutputTerm.PFI4 | PFI4 | The signal is exported to the PFI 4 connector. | - +-----------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigExportOutputTerm.PFI5 | PFI5 | The signal is exported to the PFI 5 connector. | - +-----------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigExportOutputTerm.PXI_TRIG0 | PXI_Trig0 | The trigger is received on PXI trigger line 0. | - +-----------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigExportOutputTerm.PXI_TRIG1 | PXI_Trig1 | The trigger is received on PXI trigger line 1. | - +-----------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigExportOutputTerm.PXI_TRIG2 | PXI_Trig2 | The trigger is received on PXI trigger line 2. | - +-----------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigExportOutputTerm.PXI_TRIG3 | PXI_Trig3 | The trigger is received on PXI trigger line 3. | - +-----------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigExportOutputTerm.PXI_TRIG4 | PXI_Trig4 | The trigger is received on PXI trigger line 4. | - +-----------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigExportOutputTerm.PXI_TRIG5 | PXI_Trig5 | The trigger is received on PXI trigger line 5. | - +-----------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigExportOutputTerm.PXI_TRIG6 | PXI_Trig6 | The trigger is received on PXI trigger line 6. | - +-----------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigExportOutputTerm.PXIE_DSTARC | PXIe_DStarC | The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. | - +-----------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigExportOutputTerm.TRIG_OUT | TrigOut | The signal is exported to the TRIG IN/OUT terminal. This value is valid on only the PXIe-5654/5654 with PXIe-5696. | - +-----------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigExportOutputTerm.DIO0 | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | - +-----------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigExportOutputTerm.DIO1 | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | - +-----------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigExportOutputTerm.DIO2 | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | - +-----------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigExportOutputTerm.DIO3 | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | - +-----------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigExportOutputTerm.DIO4 | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | - +-----------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigExportOutputTerm.DIO5 | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | - +-----------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigExportOutputTerm.DIO6 | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | - +-----------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | StartTrigExportOutputTerm.DIO7 | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | - +-----------------------------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------+ - - Note: - One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. + **Possible Values**: + + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Possible Value | Description | + +================+========================================================================================================================================+ + | empty | The signal is not exported. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI0 | The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI1 | The signal is exported to the PFI 1 connector. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI4 | The signal is exported to the PFI 4 connector. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PFI5 | The signal is exported to the PFI 5 connector. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | PXIe_DStarC | The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | TrigOut | The signal is exported to the TRIG IN/OUT terminal. This value is valid on only the PXIe-5654/5654 with PXIe-5696. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI0 | The trigger is received on PFI0 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI1 | The trigger is received on PFI1 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI2 | The trigger is received on PFI2 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI3 | The trigger is received on PFI3 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI4 | The trigger is received on PFI4 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI5 | The trigger is received on PFI5 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI6 | The trigger is received on PFI6 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | DIO/PFI7 | The trigger is received on PFI7 from the front panel DIO terminal. | + +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ ''' external_calibration_recommended_interval = _attributes.AttributeViInt32(1150076) '''Type: int @@ -3040,13 +3013,13 @@ class _SessionBase(object): **Defined Values**: - +--------------------------+-------------------------------------------------------------------+ - | Value | Description | - +==========================+===================================================================+ - | NIRFSG_VAL_SKIP_NONE | NI-RFSG loads all the configurations to the session. | - +--------------------------+-------------------------------------------------------------------+ - | NIRFSG_VAL_SKIP_WAVEFORM | NI-RFSG skips loading the waveform configurations to the session. | - +--------------------------+-------------------------------------------------------------------+ + +--------------------------------------------------------------------+-------------------------------------------------------------------+ + | Value | Description | + +====================================================================+===================================================================+ + | RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_LOAD_OPTIONS_SKIP_NONE | NI-RFSG loads all the configurations to the session. | + +--------------------------------------------------------------------+-------------------------------------------------------------------+ + | RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_LOAD_OPTIONS_SKIP_WAVEFORMS | NI-RFSG skips loading the waveform configurations to the session. | + +--------------------------------------------------------------------+-------------------------------------------------------------------+ 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. @@ -3061,17 +3034,17 @@ class _SessionBase(object): **Defined Values**: - +------------------------------------+------------------------------------------------------+ - | Value | Description | - +====================================+======================================================+ - | NIRFSG_VAL_SKIP_NONE | NI-RFSG resets all configurations. | - +------------------------------------+------------------------------------------------------+ - | NIRFSG_VAL_SKIP_WAVEFORMS | NI-RFSG skips resetting the waveform configurations. | - +------------------------------------+------------------------------------------------------+ - | NIRFSG_VAL_SKIP_SCRIPTS | NI-RFSG skips resetting the scripts. | - +------------------------------------+------------------------------------------------------+ - | NIRFSG_VAL_SKIP_DEEMBEDDING_TABLES | NI-RFSG skips resetting the de-embedding tables. | - +------------------------------------+------------------------------------------------------+ + +------------------------------------------------------------------------------+------------------------------------------------------+ + | Value | Description | + +==============================================================================+======================================================+ + | RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_NONE | NI-RFSG resets all configurations. | + +------------------------------------------------------------------------------+------------------------------------------------------+ + | RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_WAVEFORMS | NI-RFSG skips resetting the waveform configurations. | + +------------------------------------------------------------------------------+------------------------------------------------------+ + | RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_SCRIPTS | NI-RFSG skips resetting the scripts. | + +------------------------------------------------------------------------------+------------------------------------------------------+ + | RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_DEEMBEDDING_TABLES | NI-RFSG skips resetting the de-embedding tables. | + +------------------------------------------------------------------------------+------------------------------------------------------+ 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. @@ -3284,7 +3257,7 @@ class _SessionBase(object): Specifies whether to use fractional mode for the local oscillator (LO) phase-locked loop (PLL). This property enables or disables fractional frequency tuning in the LO. Fractional mode provides a finer frequency step resolution and allows smaller values for the lo_frequency_step_size property. However, fractional mode may introduce non-harmonic spurs. - This property applies only if you set the lo_source property to LoSource.ONBOARD. + This property applies only if you set the lo_source property to NIRFSG_VAL_LO_SOURCE_ONBOARD_STR. To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the _set_attribute_vi_int32 method to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string). @@ -3311,14 +3284,14 @@ 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. ''' - lo_source = _attributes.AttributeEnum(_attributes.AttributeViString, enums.LoSource, 1150150) - '''Type: enums.LoSource + lo_source = _attributes.AttributeViString(1150150) + '''Type: str Specifies whether to use the internal or external local oscillator (LO) source. If the lo_source property is set to "" (empty string), NI-RFSG uses the internal LO source. To set this property, the NI-RFSG device must be in the Configuration state. To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the _set_attribute_vi_string method to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string). - **Default Value:** LoSource.ONBOARD + **Default Value:** NIRFSG_VAL_LO_SOURCE_ONBOARD_STR **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842 @@ -3328,23 +3301,26 @@ class _SessionBase(object): `PXIe-5831/5832 LO Sharing Using NI-RFSA and NI-RFSG `_ - **Defined Values**: + **Possible Values**: + + +------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Possible Value | Description | + +========================+==================================================================================================================================================================================================================================================================+ + | Automatic_SG_SA_Shared | NI-RFSG internally makes the configuration to share the LO between NI-RFSA and NI-RFSG. This value is valid only on the PXIe-5820/5830/5831/5832/5840/5841/5842. | + +------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | LO_In | Uses an external LO as the LO source. Connect a signal to the LO IN connector on the device and use the upconverter_center_frequency property to specify the LO frequency. | + +------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Onboard | Uses an internal LO as the LO source. If you specify an internal LO source, the LO is generated inside the device itself. | + +------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | SG_SA_Shared | Uses the same internal LO during NI-RFSA and NI-RFSG sessions. NI-RFSG selects an internal synthesizer and the synthesizer signal is switched to both the RF In and RF Out mixers. This value is valid only on the PXIe-5830/5831/5832/5841 with PXIe-5655/5842. | + +------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Secondary | Uses the PXIe-5831/5840 internal LO as the LO source. This value is valid only on the PXIe-5831 with PXIe-5653 and PXIe-5832 with PXIe-5653. | + +------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - +---------------------------------+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +=================================+========================+==================================================================================================================================================================================================================================================================+ - | LoSource.AUTOMATIC_SG_SA_SHARED | Automatic_SG_SA_Shared | NI-RFSG internally makes the configuration to share the LO between NI-RFSA and NI-RFSG. This value is valid only on the PXIe-5820/5830/5831/5832/5840/5841/5842. | - +---------------------------------+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | LoSource.LO_IN | LO_In | Uses an external LO as the LO source. Connect a signal to the LO IN connector on the device and use the upconverter_center_frequency property to specify the LO frequency. | - +---------------------------------+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | LoSource.ONBOARD | Onboard | Uses an internal LO as the LO source. If you specify an internal LO source, the LO is generated inside the device itself. | - +---------------------------------+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | LoSource.SG_SA_SHARED | SG_SA_Shared | Uses the same internal LO during NI-RFSA and NI-RFSG sessions. NI-RFSG selects an internal synthesizer and the synthesizer signal is switched to both the RF In and RF Out mixers. This value is valid only on the PXIe-5830/5831/5832/5841 with PXIe-5655/5842. | - +---------------------------------+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | LoSource.SECONDARY | Secondary | Uses the PXIe-5831/5840 internal LO as the LO source. This value is valid only on the PXIe-5831 with PXIe-5653 and PXIe-5832 with PXIe-5653. | - +---------------------------------+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - Note: For the PXIe-5841 with PXIe-5655, RF list mode is not supported when this property is set to LoSource.SG_SA_SHARED. + Note: For the PXIe-5841 with PXIe-5655, RF list mode is not supported when this property is set to NIRFSG_VAL_LO_SOURCE_SG_SA_SHARED_STR. + + Note: + One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. ''' lo_temperature = _attributes.AttributeViReal64(1150075) '''Type: float @@ -3488,7 +3464,7 @@ class _SessionBase(object): **High-Level Methods**: - - GetTerminalName + - get_terminal_name Tip: This property can be set/get on specific markers within your :py:class:`nirfsg.Session` instance. @@ -4079,50 +4055,50 @@ 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. ''' - pulse_modulation_source = _attributes.AttributeEnum(_attributes.AttributeViString, enums.PulseModulationSource, 1150308) - '''Type: enums.PulseModulationSource + 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:** PulseModulationSource.PULSE_IN + **Default Value:** NIRFSG_VAL_PULSE_IN_STR **Supported Devices:** PXIe-5842 - **Defined Values**: - - +--------------------------------+---------+----------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +================================+=========+==============================================================================================+ - | PulseModulationSource.PULSE_IN | PulseIn | The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842. | - +--------------------------------+---------+----------------------------------------------------------------------------------------------+ - | PulseModulationSource.MARKER0 | | The trigger is received from the Marker 0. | - +--------------------------------+---------+----------------------------------------------------------------------------------------------+ - | PulseModulationSource.MARKER1 | | The trigger is received from the Marker 1. | - +--------------------------------+---------+----------------------------------------------------------------------------------------------+ - | PulseModulationSource.MARKER2 | | The trigger is received from the Marker 2. | - +--------------------------------+---------+----------------------------------------------------------------------------------------------+ - | PulseModulationSource.MARKER3 | | The trigger is received from the Marker 3. | - +--------------------------------+---------+----------------------------------------------------------------------------------------------+ + **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. | + +----------------+----------------------------------------------------------------------------------------------+ Note: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. ''' - pxi_chassis_clk10_source = _attributes.AttributeEnum(_attributes.AttributeViString, enums.PxiChassisClk10Source, 1150004) - '''Type: enums.PxiChassisClk10Source + 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. - **Defined Values**: + **Possible Values**: - Name (Value): Description + Possible Value: Description - PxiChassisClk10Source.NONE (0) :Do not drive the PXI_CLK10 signal. + empty :Do not drive the PXI_CLK10 signal. - PxiChassisClk10Source.ONBOARD_CLOCK_STR (OnboardClock) :Uses the highly stable oven-controlled onboard Reference Clock to drive the PXI_CLK signal. + OnboardClock :Uses the highly stable oven-controlled onboard Reference Clock to drive the PXI_CLK signal. - PxiChassisClk10Source.REF_IN_STR (RefIn) :Uses the clock present at the front panel REF IN connector to drive the PXI_CLK signal. + RefIn :Uses the clock present at the front panel REF IN connector to drive the PXI_CLK signal. - **Default Value:** PxiChassisClk10Source.NONE + **Default Value:** empty **Supported Devices:** PXI-5610, PXI-5670/5671 @@ -4139,18 +4115,15 @@ class _SessionBase(object): 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 | - +=====================================================================+=========================================+ - | PxiChassisClk10Source.NONE, PxiChassisClk10Source.ONBOARD_CLOCK_STR | PxiChassisClk10Source.ONBOARD_CLOCK_STR | - +---------------------------------------------------------------------+-----------------------------------------+ - | PxiChassisClk10Source.NONE, PxiChassisClk10Source.REF_IN_STR | PxiChassisClk10Source.REF_IN_STR | - +---------------------------------------------------------------------+-----------------------------------------+ - | PxiChassisClk10Source.NONE, PxiChassisClk10Source.REF_IN_STR | ReferenceClockSource.PXI_CLK | - +---------------------------------------------------------------------+-----------------------------------------+ - - Note: - One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. + +----------------------------------+--------------------------+ + | pxi_chassis_clk10_source Setting | ref_clock_source Setting | + +==================================+==========================+ + | empty, OnboardClock | OnboardClock | + +----------------------------------+--------------------------+ + | empty, RefIn | RefIn | + +----------------------------------+--------------------------+ + | empty, RefIn | PXI_CLK | + +----------------------------------+--------------------------+ ''' query_instrument_status = _attributes.AttributeViBoolean(1050003) '''Type: bool @@ -4216,7 +4189,7 @@ class _SessionBase(object): ref_clock_rate = _attributes.AttributeEnum(_attributes.AttributeViReal64, enums.ReferenceClockRate, 1250322) '''Type: enums.ReferenceClockRate - Specifies the Reference Clock rate, in Hz, of the signal present at the REF IN or CLK IN connector. This property is only valid when the ref_clock_source property is set to NIRFSG_VAL_CLK_IN_STR, NIRFSG_VAL_REF_IN_STR, or ReferenceClockSource.REF_IN_2 + Specifies the Reference Clock rate, in Hz, of the signal present at the REF IN or CLK IN connector. This property is only valid when the ref_clock_source property is set to NIRFSG_VAL_CLK_IN_STR, NIRFSG_VAL_REF_IN_STR, or NIRFSG_VAL_REF_IN_2_STR To set this property, the NI-RFSG device must be in the Configuration state. If you are using the PXIe-5654/5654 with PXIe-5696, the NI-RFSG device must be in the Committed state to read this property. When you read this property, it returns the frequency the device is locked to during the Committed state. @@ -4263,12 +4236,12 @@ 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. ''' - ref_clock_source = _attributes.AttributeEnum(_attributes.AttributeViString, enums.ReferenceClockSource, 1150001) - '''Type: enums.ReferenceClockSource + 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. - **Default Value:** ReferenceClockSource.ONBOARD_CLOCK + **Default Value:** NIRFSG_VAL_ONBOARD_CLOCK_STR **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 @@ -4280,23 +4253,23 @@ class _SessionBase(object): - configure_ref_clock - **Defined Values**: - - +-------------------------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +=====================================+===============+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | ReferenceClockSource.ONBOARD_CLOCK | OnboardClock | Uses the onboard Reference Clock as the clock source. **PXIe-5830/5831** —For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831/5832, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. ** PXIe-5831/5832 with PXIe-5653** —Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector. **PXIe-5841 with PXIe-5655** —Lock to the PXIe-5655 onboard clock. Connect the REF OUT connector on the PXIe-5655 to the PXIe-5841 REF IN connector. | - +-------------------------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ReferenceClockSource.CLK_IN | ClkIn | Uses the clock signal present at the front panel CLK IN connector as the Reference Clock source. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5831 with PXIe-5653/5832/5832 with PXIe-5653/5840/5841/5841 with PXIe-5655. | - +-------------------------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ReferenceClockSource.REF_IN | RefIn | Uses the clock signal present at the front panel REF IN connector as the Reference Clock source. **PXIe-5830/5831** —For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831/5832, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. For the PXIe-5830, lock the external signal to the PXIe-3621 REF IN connector. For the PXIe-5831/5832, lock the external signal to the PXIe-3622 REF IN connector. **PXIe-5831/5832 with PXIe-5653** —Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector. Lock the external signal to the PXIe-5653 REF IN connector. **PXIe-5841 with PXIe-5655** —Lock to the signal at the REF IN connector on the associated PXIe-5655. Connect the PXIe-5655 REF OUT connector to the PXIe-5841 REF IN connector. | - +-------------------------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ReferenceClockSource.PXI_CLK | PXI_CLK | Uses the PXI_CLK signal, which is present on the PXI backplane, as the Reference Clock source. | - +-------------------------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ReferenceClockSource.REF_IN_2 | RefIn2 | This value is not valid on any supported devices. | - +-------------------------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ReferenceClockSource.PXI_CLK_MASTER | 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 ReferenceClockSource.PXI_CLK as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector. | - +-------------------------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + **Possible Values**: + + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Possible Value | Description | + +================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | OnboardClock | Uses the onboard Reference Clock as the clock source. **PXIe-5830/5831** —For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831/5832, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. ** PXIe-5831/5832 with PXIe-5653** —Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector. **PXIe-5841 with PXIe-5655** —Lock to the PXIe-5655 onboard clock. Connect the REF OUT connector on the PXIe-5655 to the PXIe-5841 REF IN connector. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ClkIn | Uses the clock signal present at the front panel CLK IN connector as the Reference Clock source. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5831 with PXIe-5653/5832/5832 with PXIe-5653/5840/5841/5841 with PXIe-5655. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | RefIn | Uses the clock signal present at the front panel REF IN connector as the Reference Clock source. **PXIe-5830/5831** —For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831/5832, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. For the PXIe-5830, lock the external signal to the PXIe-3621 REF IN connector. For the PXIe-5831/5832, lock the external signal to the PXIe-3622 REF IN connector. **PXIe-5831/5832 with PXIe-5653** —Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector. Lock the external signal to the PXIe-5653 REF IN connector. **PXIe-5841 with PXIe-5655** —Lock to the signal at the REF IN connector on the associated PXIe-5655. Connect the PXIe-5655 REF OUT connector to the PXIe-5841 REF IN connector. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_CLK | Uses the PXI_CLK signal, which is present on the PXI backplane, as the Reference Clock source. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | RefIn2 | This value is not valid on any supported devices. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | PXI_ClkMaster | This value is valid on only the PXIe-5831/5832 with PXIe-5653. **PXIe-5831/5832 with PXIe-5653** —NI-RFSG configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3622 to use NIRFSG_VAL_PXI_CLK_STR as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector. | + +----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ 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. @@ -4368,7 +4341,7 @@ class _SessionBase(object): PXIe-5840/5841: RF blanking does not occur for frequencies below 120MHz. - For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any reset or `niRFSA_reset `_ on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call ResetWithOptions or `niRFSA_ResetWithOptions `_. Select **Routes** in the **steps to omit** parameter. + For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any reset or `niRFSA_reset `_ on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call reset_with_options or `niRFSA_ResetWithOptions `_. Select **Routes** in the **steps to omit** parameter. **Default Value:** "" (empty string) @@ -4403,7 +4376,7 @@ class _SessionBase(object): Set this property to RFInLoExportEnabled.ENABLE to export the LO signal from the RF IN LO OUT terminal. - When this property is enabled, if the lo_source property is set to LoSource.LO_IN and you do not set the lo_frequency or upconverter_center_frequency properties, NI-RFSG rounds the LO frequency to approximately an LO step size as if the source was NIRFSG_VAL_ONBOARD_CLOCK_STR. This ensures that when you configure NI-RFSA and NI-RFSG with compatible settings that result in the same LO frequency, the rounding also is compatible. + When this property is enabled, if the lo_source property is set to NIRFSG_VAL_LO_SOURCE_LO_IN_STR and you do not set the lo_frequency or upconverter_center_frequency properties, NI-RFSG rounds the LO frequency to approximately an LO step size as if the source was NIRFSG_VAL_ONBOARD_CLOCK_STR. This ensures that when you configure NI-RFSA and NI-RFSG with compatible settings that result in the same LO frequency, the rounding also is compatible. **Default Value:** RFInLoExportEnabled.UNSPECIFIED @@ -4449,7 +4422,7 @@ class _SessionBase(object): **High-Level Methods**: - - GetTerminalName + - get_terminal_name Tip: This property can be set/get on specific script_triggers within your :py:class:`nirfsg.Session` instance. @@ -4691,7 +4664,7 @@ class _SessionBase(object): **High-Level Methods**: - - GetTerminalName + - get_terminal_name ''' start_trigger_terminal_name = _attributes.AttributeViString(1150114) '''Type: str @@ -4720,7 +4693,7 @@ class _SessionBase(object): **High-Level Methods**: - - GetTerminalName + - get_terminal_name ''' start_trigger_type = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.StartTrigType, 1250458) '''Type: enums.StartTrigType @@ -5221,7 +5194,7 @@ class _SessionBase(object): | NIRFSG_VAL_MARKER0, NIRFSG_VAL_MARKER1, NIRFSG_VAL_MARKER2, or NIRFSG_VAL_MARKER3 | RFBlanking.ENABLE | Error is shown. | +-----------------------------------------------------------------------------------+----------------------+-----------------------------------------------------------------------------------------------------------+ - Note: For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any reset or `niRFSA_reset `_ on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call ResetWithOptions or `niRFSA_ResetWithOptions `_. Select **Routes** in the **steps to omit** parameter. + Note: For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any reset or `niRFSA_reset `_ on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call reset_with_options or `niRFSA_ResetWithOptions `_. Select **Routes** in the **steps to omit** parameter. 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. @@ -5294,7 +5267,7 @@ class _SessionBase(object): write_waveform_burst_detection = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.WriteWaveformBurstDetection, 1150273) '''Type: enums.WriteWaveformBurstDetection - Enables the detection of burst start and burst stop locations in the waveform. You can read the detected burst start and burst stop locations using _get_waveform_burst_start_locations and _get_waveform_burst_stop_locations methods respectively. + Enables the detection of burst start and burst stop locations in the waveform. You can read the detected burst start and burst stop locations using GetWaveformBurstStartLocations and GetWaveformBurstStopLocations methods respectively. **Default Value:** WriteWaveformBurstDetection.DISABLE @@ -5312,7 +5285,7 @@ class _SessionBase(object): Note: - When you download a waveform using ReadAndDownloadWaveformFromFileTdms method and if waveform_rf_blanking property is enabled, you must set the write_waveform_burst_detection property to WriteWaveformBurstDetection.DISABLE. - - For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any reset or `niRFSA_reset `_ on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call ResetWithOptions or `niRFSA_ResetWithOptions `_. Select **Routes** in the **steps to omit** parameter. + - For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any reset or `niRFSA_reset `_ on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call reset_with_options or `niRFSA_ResetWithOptions `_. Select **Routes** in the **steps to omit** parameter. 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. @@ -5434,6 +5407,7 @@ def __setattr__(self, key, value): ''' These are code-generated ''' + @ivi_synchronized def check_attribute_vi_boolean(self, attribute, value): r'''check_attribute_vi_boolean @@ -5460,6 +5434,7 @@ def check_attribute_vi_boolean(self, attribute, value): ''' 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 @@ -5486,6 +5461,7 @@ def check_attribute_vi_int32(self, attribute, value): ''' 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 @@ -5512,6 +5488,7 @@ def check_attribute_vi_int64(self, attribute, value): ''' 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 @@ -5538,6 +5515,7 @@ def check_attribute_vi_real64(self, attribute, value): ''' 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 @@ -5560,6 +5538,7 @@ def check_attribute_vi_session(self, attribute): ''' 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 @@ -5586,6 +5565,7 @@ def check_attribute_vi_string(self, attribute, value): ''' self._interpreter.check_attribute_vi_string(self._repeated_capability, attribute, value) + @ivi_synchronized def _get_attribute_vi_boolean(self, attribute): r'''_get_attribute_vi_boolean @@ -5618,6 +5598,7 @@ def _get_attribute_vi_boolean(self, attribute): value = self._interpreter.get_attribute_vi_boolean(self._repeated_capability, attribute) return value + @ivi_synchronized def _get_attribute_vi_int32(self, attribute): r'''_get_attribute_vi_int32 @@ -5650,6 +5631,7 @@ def _get_attribute_vi_int32(self, attribute): value = self._interpreter.get_attribute_vi_int32(self._repeated_capability, attribute) return value + @ivi_synchronized def _get_attribute_vi_int64(self, attribute): r'''_get_attribute_vi_int64 @@ -5682,6 +5664,7 @@ def _get_attribute_vi_int64(self, attribute): value = self._interpreter.get_attribute_vi_int64(self._repeated_capability, attribute) return value + @ivi_synchronized def _get_attribute_vi_real64(self, attribute): r'''_get_attribute_vi_real64 @@ -5714,6 +5697,7 @@ def _get_attribute_vi_real64(self, attribute): value = self._interpreter.get_attribute_vi_real64(self._repeated_capability, attribute) return value + @ivi_synchronized def _get_attribute_vi_session(self, attribute): r'''_get_attribute_vi_session @@ -5746,6 +5730,7 @@ def _get_attribute_vi_session(self, attribute): value = self._interpreter.get_attribute_vi_session(self._repeated_capability, attribute) return value + @ivi_synchronized def _get_attribute_vi_string(self, attribute): r'''_get_attribute_vi_string @@ -5784,114 +5769,7 @@ def _get_attribute_vi_string(self, attribute): value = self._interpreter.get_attribute_vi_string(self._repeated_capability, attribute) return value - def _get_waveform_burst_start_locations(self, number_of_locations): - r'''_get_waveform_burst_start_locations - - Returns the burst start locations of the waveform stored in the NI-RFSG session. - - **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842 - - 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[ ... ]._get_waveform_burst_start_locations` - - To call the method on all channels, you can call it directly on the :py:class:`nirfsg.Session`. - - Example: :py:meth:`my_session._get_waveform_burst_start_locations` - - Args: - number_of_locations (int): Specifies the size of the burst start locations array. - - - Returns: - locations (float): Returns the burst start locations stored in the NI-RFSG session for the waveform that you specified in the **CHANNEL_NAME** parameter. This value is expressed in samples. - - Note: - One or more of the referenced properties are not in the Python API for this driver. - - required_size (int): Returns the required size for the output array if you pass NULL to LOCATIONS parameter. - - Note: - One or more of the referenced properties are not in the Python API for this driver. - - ''' - locations, required_size = self._interpreter.get_waveform_burst_start_locations(self._repeated_capability, number_of_locations) - return locations, required_size - - def _get_waveform_burst_stop_locations(self, number_of_locations): - r'''_get_waveform_burst_stop_locations - - Returns the burst stop locations of the waveform stored in the NI-RFSG session. - - **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842 - - 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[ ... ]._get_waveform_burst_stop_locations` - - To call the method on all channels, you can call it directly on the :py:class:`nirfsg.Session`. - - Example: :py:meth:`my_session._get_waveform_burst_stop_locations` - - Args: - number_of_locations (int): Specifies the size of the burst start locations array. - - - Returns: - locations (float): Returns the burst start locations stored in the NI-RFSG session for the waveform that you specified in the **CHANNEL_NAME** parameter. This value is expressed in samples. - - Note: - One or more of the referenced properties are not in the Python API for this driver. - - required_size (int): Returns the required size for the output array if you pass NULL to LOCATIONS parameter. - - Note: - One or more of the referenced properties are not in the Python API for this driver. - - ''' - locations, required_size = self._interpreter.get_waveform_burst_stop_locations(self._repeated_capability, number_of_locations) - return locations, required_size - - def _get_waveform_marker_event_locations(self, number_of_locations): - r'''_get_waveform_marker_event_locations - - Returns the marker locations associated with the waveform and the marker stored in the NI-RFSG session. - - **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842 - - 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[ ... ]._get_waveform_marker_event_locations` - - To call the method on all channels, you can call it directly on the :py:class:`nirfsg.Session`. - - Example: :py:meth:`my_session._get_waveform_marker_event_locations` - - Args: - number_of_locations (int): Specifies the size of the locations array. - - - Returns: - locations (float): Returns the marker locations stored in the NI-RFSG database for the channel you specified in the **CHANNEL_NAME** parameter. This value is expressed in samples. - - Note: - One or more of the referenced properties are not in the Python API for this driver. - - required_size (int): Returns the required size for the output array if you pass NULL to **Locations** parameter. - - ''' - locations, required_size = self._interpreter.get_waveform_marker_event_locations(self._repeated_capability, number_of_locations) - return locations, required_size - + @ivi_synchronized def load_configurations_from_file(self, file_path): r'''load_configurations_from_file @@ -5953,6 +5831,7 @@ def lock(self): # that will handle the unlock for them return _Lock(self) + @ivi_synchronized def reset_attribute(self, attribute_id): r'''reset_attribute @@ -5977,6 +5856,7 @@ def reset_attribute(self, attribute_id): ''' self._interpreter.reset_attribute(self._repeated_capability, attribute_id) + @ivi_synchronized def save_configurations_to_file(self, file_path): r'''save_configurations_to_file @@ -6001,6 +5881,7 @@ def save_configurations_to_file(self, file_path): ''' self._interpreter.save_configurations_to_file(self._repeated_capability, file_path) + @ivi_synchronized def send_software_edge_trigger(self, trigger, trigger_identifier): r'''send_software_edge_trigger @@ -6032,25 +5913,25 @@ def send_software_edge_trigger(self, trigger, trigger_identifier): Note: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. - trigger_identifier (enums.TriggerIdentifier): Specifies the Script Trigger to configure. This parameter is valid only when you set the TRIGGER parameter to NIRFSG_VAL_START_TRIGGER. Otherwise, set the **TRIGGER_IDENTIFIER** parameter to "" (empty string). + trigger_identifier (str): Specifies the Script Trigger to configure. This parameter is valid only when you set the TRIGGER parameter to NIRFSG_VAL_START_TRIGGER. Otherwise, set the TRIGGER_IDENTIFIER parameter to "" (empty string). **Default Value:** "" (empty string) - **Defined Values:** - - +-------------------------------------+----------------+-----------------------------+ - | Name | Value | Description | - +=====================================+================+=============================+ - | TriggerIdentifier.SCRIPT_TRIGGER0 | scriptTrigger0 | Specifies Script Trigger 0. | - +-------------------------------------+----------------+-----------------------------+ - | TriggerIdentifier.SCRIPT_TRIGGER1 | scriptTrigger1 | Specifies Script Trigger 1. | - +-------------------------------------+----------------+-----------------------------+ - | TriggerIdentifier.SCRIPT_TRIGGER2 | scriptTrigger2 | Specifies Script Trigger 2. | - +-------------------------------------+----------------+-----------------------------+ - | TriggerIdentifier.SCRIPT_TRIGGER3 | scriptTrigger3 | Specifies Script Trigger 3. | - +-------------------------------------+----------------+-----------------------------+ - | TriggerIdentifier.NONE_EMPTY_STRING | | None (no signal to export) | - +-------------------------------------+----------------+-----------------------------+ + **Possible Values:** + + +----------------+-----------------------------+ + | Possible Value | Description | + +================+=============================+ + | scriptTrigger0 | Specifies Script Trigger 0. | + +----------------+-----------------------------+ + | scriptTrigger1 | Specifies Script Trigger 1. | + +----------------+-----------------------------+ + | scriptTrigger2 | Specifies Script Trigger 2. | + +----------------+-----------------------------+ + | scriptTrigger3 | Specifies Script Trigger 3. | + +----------------+-----------------------------+ + | | None (no signal to export) | + +----------------+-----------------------------+ Note: One or more of the referenced properties are not in the Python API for this driver. @@ -6061,10 +5942,9 @@ def send_software_edge_trigger(self, trigger, trigger_identifier): ''' if type(trigger) is not enums.SoftwareTriggerType: raise TypeError('Parameter trigger must be of type ' + str(enums.SoftwareTriggerType)) - if type(trigger_identifier) is not enums.TriggerIdentifier: - raise TypeError('Parameter trigger_identifier must be of type ' + str(enums.TriggerIdentifier)) self._interpreter.send_software_edge_trigger(trigger, trigger_identifier) + @ivi_synchronized def _set_attribute_vi_boolean(self, attribute, value): r'''_set_attribute_vi_boolean @@ -6100,6 +5980,7 @@ def _set_attribute_vi_boolean(self, attribute, value): ''' self._interpreter.set_attribute_vi_boolean(self._repeated_capability, attribute, value) + @ivi_synchronized def _set_attribute_vi_int32(self, attribute, value): r'''_set_attribute_vi_int32 @@ -6135,6 +6016,7 @@ def _set_attribute_vi_int32(self, attribute, value): ''' self._interpreter.set_attribute_vi_int32(self._repeated_capability, attribute, value) + @ivi_synchronized def _set_attribute_vi_int64(self, attribute, value): r'''_set_attribute_vi_int64 @@ -6172,6 +6054,7 @@ def _set_attribute_vi_int64(self, attribute, value): ''' self._interpreter.set_attribute_vi_int64(self._repeated_capability, attribute, value) + @ivi_synchronized def _set_attribute_vi_real64(self, attribute, value): r'''_set_attribute_vi_real64 @@ -6207,6 +6090,7 @@ def _set_attribute_vi_real64(self, attribute, value): ''' self._interpreter.set_attribute_vi_real64(self._repeated_capability, attribute, value) + @ivi_synchronized def _set_attribute_vi_session(self, attribute): r'''_set_attribute_vi_session @@ -6238,6 +6122,7 @@ def _set_attribute_vi_session(self, attribute): ''' self._interpreter.set_attribute_vi_session(self._repeated_capability, attribute) + @ivi_synchronized def _set_attribute_vi_string(self, attribute, value): r'''_set_attribute_vi_string @@ -6273,96 +6158,6 @@ def _set_attribute_vi_string(self, attribute, value): ''' self._interpreter.set_attribute_vi_string(self._repeated_capability, attribute, value) - def _set_waveform_burst_start_locations(self, number_of_locations): - r'''_set_waveform_burst_start_locations - - Configures the start location of the burst in samples where the burst refers to the active portion of a waveform. - - **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842 - - 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[ ... ]._set_waveform_burst_start_locations` - - To call the method on all channels, you can call it directly on the :py:class:`nirfsg.Session`. - - Example: :py:meth:`my_session._set_waveform_burst_start_locations` - - Args: - number_of_locations (int): Specifies the size of the burst start locations array. - - - Returns: - locations (float): Returns the burst start locations stored in the NI-RFSG session for the waveform that you specified in the **CHANNEL_NAME** parameter. This value is expressed in samples. - - Note: - One or more of the referenced properties are not in the Python API for this driver. - - ''' - locations = self._interpreter.set_waveform_burst_start_locations(self._repeated_capability, number_of_locations) - return locations - - def _set_waveform_burst_stop_locations(self, number_of_locations): - r'''_set_waveform_burst_stop_locations - - Configures the stop location of the burst in samples where the burst refers to the active portion of a waveform. - - **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842 - - 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[ ... ]._set_waveform_burst_stop_locations` - - To call the method on all channels, you can call it directly on the :py:class:`nirfsg.Session`. - - Example: :py:meth:`my_session._set_waveform_burst_stop_locations` - - Args: - number_of_locations (int): Specifies the size of the burst stop locations array. - - - Returns: - locations (float): Specifies the burst stop locations, in samples, to store in the NI-RFSG session. - - ''' - locations = self._interpreter.set_waveform_burst_stop_locations(self._repeated_capability, number_of_locations) - return locations - - def _set_waveform_marker_event_locations(self, number_of_locations): - r'''_set_waveform_marker_event_locations - - Configures the marker locations associated with waveform and marker in the NI-RFSG session. - - **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842 - - 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[ ... ]._set_waveform_marker_event_locations` - - To call the method on all channels, you can call it directly on the :py:class:`nirfsg.Session`. - - Example: :py:meth:`my_session._set_waveform_marker_event_locations` - - Args: - number_of_locations (int): Specifies the size of the locations array. - - - Returns: - locations (float): Specifies the marker location, in samples, to store in the NI-RFSG database. - - ''' - locations = self._interpreter.set_waveform_marker_event_locations(self._repeated_capability, number_of_locations) - return locations - def unlock(self): '''unlock @@ -6376,12 +6171,12 @@ def unlock(self): class Session(_SessionBase): '''An NI-RFSG session to the NI-RFSG driver''' - def __init__(self, resource_name, id_query, reset_device, options={}): + def __init__(self, resource_name, options={}, id_query=False, reset_device=False): r'''An NI-RFSG session to the NI-RFSG driver - Opens a session to the device you specify as the **RESOURCE_NAME** and returns a ViSession handle that you use to identify the NI-RFSG device in all subsequent NI-RFSG method calls. + Opens a session to the device you specify as the RESOURCE_NAME and returns a ViSession handle that you use to identify the NI-RFSG device in all subsequent NI-RFSG method calls. - This method also configures the device through the **OPTION_STRING** input. + This method also configures the device through the OPTION_STRING input. **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -6403,30 +6198,6 @@ def __init__(self, resource_name, id_query, reset_device, options={}): Note: NI-RFSG device names are not case-sensitive. However, all IVI names, such as logical names, are case-sensitive. If you use an IVI logical name, make sure the name is identical to the name shown in the IVI Configuration Utility. - id_query (bool): Specifies whether you want NI-RFSG to perform an ID query. - - **Defined Values** : - - +-----------+--------------------------+ - | Value | Description | - +===========+==========================+ - | True (1) | Perform ID query. | - +-----------+--------------------------+ - | False (0) | Do not perform ID query. | - +-----------+--------------------------+ - - reset_device (bool): Specifies whether you want to reset the NI-RFSG device during the initialization procedure. - - **Defined Values** : - - +-----------+----------------------+ - | Value | Description | - +===========+======================+ - | True (1) | Reset device. | - +-----------+----------------------+ - | False (0) | Do not reset device. | - +-----------+----------------------+ - options (str): Specifies the initial value of certain properties for the session. The syntax for **options** is a dictionary of properties with an assigned value. For example: @@ -6455,6 +6226,30 @@ def __init__(self, resource_name, id_query, reset_device, options={}): | driver_setup | {} | +-------------------------+---------+ + id_query (bool): Specifies whether you want NI-RFSG to perform an ID query. + + **Defined Values** : + + +-----------+--------------------------+ + | Value | Description | + +===========+==========================+ + | True (1) | Perform ID query. | + +-----------+--------------------------+ + | False (0) | Do not perform ID query. | + +-----------+--------------------------+ + + reset_device (bool): Specifies whether you want to reset the NI-RFSG device during the initialization procedure. + + **Defined Values** : + + +-----------+----------------------+ + | Value | Description | + +===========+======================+ + | True (1) | Reset device. | + +-----------+----------------------+ + | False (0) | Do not reset device. | + +-----------+----------------------+ + Returns: new_vi (int): Returns a ViSession handle that you use to identify the NI-RFSG device in all subsequent NI-RFSG method calls. @@ -6475,16 +6270,16 @@ def __init__(self, resource_name, id_query, reset_device, options={}): # if _init_with_options fails, the error handler can reference it. # And then here, once _init_with_options succeeds, we call set_session_handle # with the actual session handle. - self._interpreter.set_session_handle(self._init_with_options(resource_name, id_query, reset_device, options)) + self._interpreter.set_session_handle(self._init_with_options(resource_name, options, id_query, reset_device)) self.tclk = nitclk.SessionReference(self._interpreter.get_session_handle()) # Store the parameter list for later printing in __repr__ param_list = [] param_list.append("resource_name=" + pp.pformat(resource_name)) + param_list.append("options=" + pp.pformat(options)) param_list.append("id_query=" + pp.pformat(id_query)) param_list.append("reset_device=" + pp.pformat(reset_device)) - param_list.append("options=" + pp.pformat(options)) self._param_list = ', '.join(param_list) # Store the list of channels in the Session which is needed by some nimi-python modules. @@ -6549,6 +6344,7 @@ def close(self): ''' These are code-generated ''' + @ivi_synchronized def abort(self): r'''abort @@ -6562,6 +6358,7 @@ def abort(self): ''' self._interpreter.abort() + @ivi_synchronized def allocate_arb_waveform(self, waveform_name, size_in_samples): r'''allocate_arb_waveform @@ -6585,6 +6382,7 @@ def allocate_arb_waveform(self, waveform_name, size_in_samples): ''' self._interpreter.allocate_arb_waveform(waveform_name, size_in_samples) + @ivi_synchronized def change_external_calibration_password(self, old_password, new_password): r'''change_external_calibration_password @@ -6600,6 +6398,7 @@ def change_external_calibration_password(self, old_password, new_password): ''' self._interpreter.change_external_calibration_password(old_password, new_password) + @ivi_synchronized def check_generation_status(self): r'''check_generation_status @@ -6632,10 +6431,11 @@ def check_generation_status(self): is_done = self._interpreter.check_generation_status() return is_done + @ivi_synchronized def check_if_script_exists(self, script_name): r'''check_if_script_exists - Returns whether the script that you specify as **SCRIPT_NAME** exists. + Returns whether the script that you specify as SCRIPT_NAME exists. **Supported Devices** : PXIe-5673/5673E. PXIe-5830/5831/5840/5841/5842/5860 @@ -6663,10 +6463,11 @@ def check_if_script_exists(self, script_name): script_exists = self._interpreter.check_if_script_exists(script_name) return script_exists + @ivi_synchronized def check_if_waveform_exists(self, waveform_name): r'''check_if_waveform_exists - Returns whether the waveform that you specify as **WAVEFORM_NAME** exists. + Returns whether the waveform that you specify as WAVEFORM_NAME exists. **Supported Devices** : PXIe-5673/5673E, PXIe-5830/5831/5840/5841/5842/5860 @@ -6694,6 +6495,7 @@ def check_if_waveform_exists(self, waveform_name): waveform_exists = self._interpreter.check_if_waveform_exists(waveform_name) return waveform_exists + @ivi_synchronized def clear_all_arb_waveforms(self): r'''clear_all_arb_waveforms @@ -6705,6 +6507,7 @@ def clear_all_arb_waveforms(self): ''' self._interpreter.clear_all_arb_waveforms() + @ivi_synchronized def clear_arb_waveform(self, name): r'''clear_arb_waveform @@ -6720,6 +6523,7 @@ def clear_arb_waveform(self, name): ''' self._interpreter.clear_arb_waveform(name) + @ivi_synchronized def clear_error(self): r'''clear_error @@ -6738,6 +6542,7 @@ def clear_error(self): ''' self._interpreter.clear_error() + @ivi_synchronized def clear_self_calibrate_range(self): r'''clear_self_calibrate_range @@ -6747,6 +6552,7 @@ def clear_self_calibrate_range(self): ''' self._interpreter.clear_self_calibrate_range() + @ivi_synchronized def commit(self): r'''commit @@ -6762,6 +6568,7 @@ def commit(self): ''' self._interpreter.commit() + @ivi_synchronized def configure_deembedding_table_interpolation_linear(self, port, table_name, format): r'''configure_deembedding_table_interpolation_linear @@ -6793,6 +6600,7 @@ def configure_deembedding_table_interpolation_linear(self, port, table_name, for raise TypeError('Parameter format must be of type ' + str(enums.Format)) self._interpreter.configure_deembedding_table_interpolation_linear(port, table_name, format) + @ivi_synchronized def configure_deembedding_table_interpolation_nearest(self, port, table_name): r'''configure_deembedding_table_interpolation_nearest @@ -6810,6 +6618,7 @@ def configure_deembedding_table_interpolation_nearest(self, port, table_name): ''' self._interpreter.configure_deembedding_table_interpolation_nearest(port, table_name) + @ivi_synchronized def configure_deembedding_table_interpolation_spline(self, port, table_name): r'''configure_deembedding_table_interpolation_spline @@ -6827,6 +6636,7 @@ def configure_deembedding_table_interpolation_spline(self, port, table_name): ''' self._interpreter.configure_deembedding_table_interpolation_spline(port, table_name) + @ivi_synchronized def configure_digital_edge_script_trigger(self, trigger_id, source, edge): r'''configure_digital_edge_script_trigger @@ -6854,6 +6664,7 @@ def configure_digital_edge_script_trigger(self, trigger_id, source, edge): ''' self._interpreter.configure_digital_edge_script_trigger(trigger_id, source, edge) + @ivi_synchronized def configure_digital_edge_start_trigger(self, source, edge): r'''configure_digital_edge_start_trigger @@ -6879,6 +6690,7 @@ def configure_digital_edge_start_trigger(self, source, edge): ''' self._interpreter.configure_digital_edge_start_trigger(source, edge) + @ivi_synchronized def configure_digital_level_script_trigger(self, trigger_id, source, level): r'''configure_digital_level_script_trigger @@ -6904,6 +6716,7 @@ def configure_digital_level_script_trigger(self, trigger_id, source, level): ''' self._interpreter.configure_digital_level_script_trigger(trigger_id, source, level) + @ivi_synchronized def configure_digital_modulation_user_defined_waveform(self, number_of_samples, user_defined_waveform): r'''configure_digital_modulation_user_defined_waveform @@ -6922,6 +6735,7 @@ def configure_digital_modulation_user_defined_waveform(self, number_of_samples, ''' self._interpreter.configure_digital_modulation_user_defined_waveform(number_of_samples, user_defined_waveform) + @ivi_synchronized def configure_generation_mode(self, generation_mode): r'''configure_generation_mode @@ -6963,12 +6777,13 @@ def configure_generation_mode(self, generation_mode): raise TypeError('Parameter generation_mode must be of type ' + str(enums.GenerationMode)) self._interpreter.configure_generation_mode(generation_mode) + @ivi_synchronized def configure_output_enabled(self, output_enabled): r'''configure_output_enabled Enables or disables signal output. - Setting **output_enabled** to False while in the Generation state attenuates the generated signal so that no signal is output. + Setting output_enabled to False while in the Generation state attenuates the generated signal so that no signal is output. **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -6986,12 +6801,13 @@ def configure_output_enabled(self, output_enabled): ''' self._interpreter.configure_output_enabled(output_enabled) + @ivi_synchronized def configure_p2_p_endpoint_fullness_start_trigger(self, p2p_endpoint_fullness_level): r'''configure_p2_p_endpoint_fullness_start_trigger Configures the Start Trigger to detect peer-to-peer endpoint fullness. - Generation begins when the number of samples in the peer-to-peer endpoint reaches the threshold specified by the **P2P_ENDPOINT_FULLNESS_LEVEL** parameter. The NI-RFSG device must be in the Configuration state before calling this method. + Generation begins when the number of samples in the peer-to-peer endpoint reaches the threshold specified by the P2P_ENDPOINT_FULLNESS_LEVEL parameter. The NI-RFSG device must be in the Configuration state before calling this method. **Supported Devices** : PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 @@ -7010,6 +6826,7 @@ def configure_p2_p_endpoint_fullness_start_trigger(self, p2p_endpoint_fullness_l ''' self._interpreter.configure_p2_p_endpoint_fullness_start_trigger(p2p_endpoint_fullness_level) + @ivi_synchronized def configure_power_level_type(self, power_level_type): r'''configure_power_level_type @@ -7039,6 +6856,7 @@ def configure_power_level_type(self, power_level_type): ''' self._interpreter.configure_power_level_type(power_level_type) + @ivi_synchronized def configure_pxi_chassis_clk10(self, pxi_clk10_source): r'''configure_pxi_chassis_clk10 @@ -7060,6 +6878,7 @@ def configure_pxi_chassis_clk10(self, pxi_clk10_source): ''' self._interpreter.configure_pxi_chassis_clk10(pxi_clk10_source) + @ivi_synchronized def configure_rf(self, frequency, power_level): r'''configure_rf @@ -7085,6 +6904,7 @@ def configure_rf(self, frequency, power_level): ''' self._interpreter.configure_rf(frequency, power_level) + @ivi_synchronized def configure_ref_clock(self, ref_clock_source, ref_clock_rate): r'''configure_ref_clock @@ -7116,19 +6936,19 @@ def configure_ref_clock(self, ref_clock_source, ref_clock_rate): +----------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | NIRFSG_VAL_REF_IN_STR | RefIn | Uses the clock signal present at the front panel REF IN connector as the clock source. **PXIe-5830/5831/5832** :For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. For the PXIe-5832, connect the PXIe-5820 REF IN connector to the PXIe-3623 REF OUT connector. For the PXIe-5830, lock the external signal to the PXIe-3621 REF IN connector. For the PXIe-5831, lock the external signal to the PXIe-3622 REF IN connector. For the PXIe-5832, lock the external signal to the PXIe-3623 REF IN connector. **PXIe-5831 with PXIe-5653** :Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector. Lock the external signal to the PXIe-5653 REF IN connector. **PXIe-5832 with PXIe-5653** :Connect the PXIe-5820 REF IN connector to the PXIe-3623 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3623 REF IN connector. Lock the external signal to the PXIe-5653 REF IN connector. **PXIe-5841 with PXIe-5655** :Lock to the signal at the REF IN connector on the associated PXIe-5655. Connect the PXIe-5655 REF OUT connector to the PXIe-5841 REF IN connector. **PXIe-5842** :Lock to the signal at the REF IN connector on the associated PXIe-5655. Cables between modules are required as shown in the Getting Started Guide for the instrument. | +----------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ReferenceClockSource.PXI_CLK | PXI_CLK | Uses the PXI_CLK signal, which is present on the PXI backplane, as the clock source. | + | NIRFSG_VAL_PXI_CLK_STR | PXI_CLK | Uses the PXI_CLK signal, which is present on the PXI backplane, as the clock source. | +----------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | NIRFSG_VAL_CLK_IN_STR | ClkIn | Uses the clock signal present at the front panel CLK IN connector as the clock source. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5831 with PXIe-5653/5832/5832 with PXIe-5653/5840/5841/5841 with PXIe-5655/5842. | +----------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ReferenceClockSource.REF_IN_2 | RefIn2 | - | + | NIRFSG_VAL_REF_IN_2_STR | RefIn2 | \- | +----------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ReferenceClockSource.PXI_CLK_MASTER | PXI_ClkMaster | This value is valid on only the PXIe-5831 with PXIe-5653 and PXIe-5832 with PXIe-5653. **PXIe-5831 with PXIe-5653** :NI-RFSG configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3622 to use PXI_Clk as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector. **PXIe-5832 with PXIe-5653** :NI-RFSG configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3623 to use PXI_Clk as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector. | + | NIRFSG_VAL_PXI_CLK_MASTER_STR | PXI_ClkMaster | This value is valid on only the PXIe-5831 with PXIe-5653 and PXIe-5832 with PXIe-5653. **PXIe-5831 with PXIe-5653** :NI-RFSG configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3622 to use PXI_Clk as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector. **PXIe-5832 with PXIe-5653** :NI-RFSG configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3623 to use PXI_Clk as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector. | +----------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Note: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. - ref_clock_rate (float): Specifies the Reference Clock rate, in hertz (Hz), of the signal present at the REF IN or CLK IN connector. The default value is NIRFSG_VAL_AUTO, which allows NI-RFSG to use the default Reference Clock rate for the device or automatically detect the Reference Clock rate, if supported. This parameter is only valid when the **ref_clock_source** parameter is set to NIRFSG_VAL_CLK_IN_STR, NIRFSG_VAL_REF_IN_STR or ReferenceClockSource.REF_IN_2. Refer to the ref_clock_rate property for possible values. + ref_clock_rate (float): Specifies the Reference Clock rate, in hertz (Hz), of the signal present at the REF IN or CLK IN connector. The default value is NIRFSG_VAL_AUTO, which allows NI-RFSG to use the default Reference Clock rate for the device or automatically detect the Reference Clock rate, if supported. This parameter is only valid when the ref_clock_source parameter is set to NIRFSG_VAL_CLK_IN_STR, NIRFSG_VAL_REF_IN_STR or NIRFSG_VAL_REF_IN_2_STR. Refer to the ref_clock_rate property for possible values. 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. @@ -7136,6 +6956,7 @@ def configure_ref_clock(self, ref_clock_source, ref_clock_rate): ''' self._interpreter.configure_ref_clock(ref_clock_source, ref_clock_rate) + @ivi_synchronized def configure_signal_bandwidth(self, signal_bandwidth): r'''configure_signal_bandwidth @@ -7155,6 +6976,7 @@ def configure_signal_bandwidth(self, signal_bandwidth): ''' self._interpreter.configure_signal_bandwidth(signal_bandwidth) + @ivi_synchronized def configure_software_script_trigger(self, trigger_id): r'''configure_software_script_trigger @@ -7176,6 +6998,7 @@ def configure_software_script_trigger(self, trigger_id): ''' self._interpreter.configure_software_script_trigger(trigger_id) + @ivi_synchronized def configure_software_start_trigger(self): r'''configure_software_start_trigger @@ -7195,6 +7018,7 @@ def configure_software_start_trigger(self): ''' self._interpreter.configure_software_start_trigger() + @ivi_synchronized def create_deembedding_sparameter_table_s2_p_file(self, port, table_name, s2p_file_path, sparameter_orientation): r'''create_deembedding_sparameter_table_s2_p_file @@ -7232,6 +7056,7 @@ def create_deembedding_sparameter_table_s2_p_file(self, port, table_name, s2p_fi raise TypeError('Parameter sparameter_orientation must be of type ' + str(enums.SparameterOrientation)) self._interpreter.create_deembedding_sparameter_table_s2_p_file(port, table_name, s2p_file_path, sparameter_orientation) + @ivi_synchronized def delete_all_deembedding_tables(self): r'''delete_all_deembedding_tables @@ -7241,6 +7066,7 @@ def delete_all_deembedding_tables(self): ''' self._interpreter.delete_all_deembedding_tables() + @ivi_synchronized def delete_deembedding_table(self, port, table_name): r'''delete_deembedding_table @@ -7256,6 +7082,7 @@ def delete_deembedding_table(self, port, table_name): ''' self._interpreter.delete_deembedding_table(port, table_name) + @ivi_synchronized def disable(self): r'''disable @@ -7265,6 +7092,7 @@ def disable(self): ''' self._interpreter.disable() + @ivi_synchronized def disable_script_trigger(self, trigger_id): r'''disable_script_trigger @@ -7284,6 +7112,7 @@ def disable_script_trigger(self, trigger_id): ''' self._interpreter.disable_script_trigger(trigger_id) + @ivi_synchronized def disable_start_trigger(self): r'''disable_start_trigger @@ -7299,6 +7128,7 @@ def disable_start_trigger(self): ''' self._interpreter.disable_start_trigger() + @ivi_synchronized def export_signal(self, signal, signal_identifier, output_terminal): r'''export_signal @@ -7346,27 +7176,27 @@ def export_signal(self, signal, signal_identifier, output_terminal): Note: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. - signal_identifier (enums.SignalIdentifier): Specifies which instance of the selected signal to export. This parameter is useful when you set the SIGNAL parameter to NIRFSG_VAL_SCRIPT_TRIGGER or NIRFSG_VAL_MARKER_EVENT. Otherwise, set the SIGNAL_IDENTIFIER parameter to '' (empty string). **Defined Values** : - - +----------------------------------+----------------+-----------------------------+ - | Name | Value | Description | - +==================================+================+=============================+ - | SignalIdentifier.MARKER_EVENT0 | marker0 | Specifies Marker 0. | - +----------------------------------+----------------+-----------------------------+ - | SignalIdentifier.MARKER_EVENT1 | marker1 | Specifies Marker 1. | - +----------------------------------+----------------+-----------------------------+ - | SignalIdentifier.MARKER_EVENT2 | marker2 | Specifies Marker 2. | - +----------------------------------+----------------+-----------------------------+ - | SignalIdentifier.MARKER_EVENT3 | marker3 | Specifies Marker 3. | - +----------------------------------+----------------+-----------------------------+ - | SignalIdentifier.SCRIPT_TRIGGER0 | scriptTrigger0 | Specifies Script Trigger 0. | - +----------------------------------+----------------+-----------------------------+ - | SignalIdentifier.SCRIPT_TRIGGER1 | scriptTrigger1 | Specifies Script Trigger 1. | - +----------------------------------+----------------+-----------------------------+ - | SignalIdentifier.SCRIPT_TRIGGER2 | scriptTrigger2 | Specifies Script Trigger 2. | - +----------------------------------+----------------+-----------------------------+ - | SignalIdentifier.SCRIPT_TRIGGER3 | scriptTrigger3 | Specifies Script Trigger 3. | - +----------------------------------+----------------+-----------------------------+ + signal_identifier (str): Specifies which instance of the selected signal to export. This parameter is useful when you set the SIGNAL parameter to NIRFSG_VAL_SCRIPT_TRIGGER or NIRFSG_VAL_MARKER_EVENT. Otherwise, set the SIGNAL_IDENTIFIER parameter to '' (empty string). **Possible Values** : + + +----------------+-----------------------------+ + | Possible Value | Description | + +================+=============================+ + | marker0 | Specifies Marker 0. | + +----------------+-----------------------------+ + | marker1 | Specifies Marker 1. | + +----------------+-----------------------------+ + | marker2 | Specifies Marker 2. | + +----------------+-----------------------------+ + | marker3 | Specifies Marker 3. | + +----------------+-----------------------------+ + | scriptTrigger0 | Specifies Script Trigger 0. | + +----------------+-----------------------------+ + | scriptTrigger1 | Specifies Script Trigger 1. | + +----------------+-----------------------------+ + | scriptTrigger2 | Specifies Script Trigger 2. | + +----------------+-----------------------------+ + | scriptTrigger3 | Specifies Script Trigger 3. | + +----------------+-----------------------------+ Note: One or more of the referenced properties are not in the Python API for this driver. @@ -7374,32 +7204,89 @@ def export_signal(self, signal, signal_identifier, output_terminal): Note: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. - output_terminal (enums.ReferenceClockExportOutputTerminal): Specifies the terminal where the signal is exported. You can choose not to export any signal. For the PXIe-5841 with PXIe-5655, the signal is exported to the terminal on the PXIe-5841. **Defined Values** : - - +--------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | | - +==================================================+=========+============================================================================================+=======================================================================================================================================================================+ - | ReferenceClockExportOutputTerminal.CLK_OUT | ClkOut | Exports the Reference Clock signal to the CLK OUT connector of the device. | Supported on PXIe-5673, 5673E | - +--------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ReferenceClockExportOutputTerminal.DO_NOT_EXPORT | | The Reference Clock signal is not exported. | Supported on PXIe-5644/5645/5646, 5820/5830/5831/5832/5840/5841/5842/5860, 5650/5651/5652, 5654, 5673, 5673E, PXIe-5654 with PXIe-5696, PXI-5650/5651/5652 (See Note) | - +--------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ReferenceClockExportOutputTerminal.REF_OUT | RefOut | Exports the Reference Clock signal to the REF OUT connector of the device. | Supported on PXIe-5644/5645/5646, 5820/5830/5831/5832/5840/5841/5842/5860, 5650/5651/5653, 5653, 5654, 5673, 5673E, PXIe-5654 with PXIe-5696, PXI-5650/5651/5653, | - +--------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ReferenceClockExportOutputTerminal.REF_OUT2 | RefOut2 | Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable. | Supported on PXIe-5650/5651/5652, 5654, 5673E, PXIe-5654 with PXIe-5696 | - +--------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + output_terminal (str): Specifies the terminal where the signal is exported. You can choose not to export any signal. For the PXIe-5841 with PXIe-5655, the signal is exported to the terminal on the PXIe-5841. **Possible Values** : - Note: - One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. + +----------------+--------------------------------------------------------------------------------------------+ + | Possible Value | Description | + +================+============================================================================================+ + | ClkOut | Exports the Reference Clock signal to the CLK OUT connector of the device. | + +----------------+--------------------------------------------------------------------------------------------+ + | | The Reference Clock signal is not exported. | + +----------------+--------------------------------------------------------------------------------------------+ + | RefOut | Exports the Reference Clock signal to the REF OUT connector of the device. | + +----------------+--------------------------------------------------------------------------------------------+ + | RefOut2 | Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable. | + +----------------+--------------------------------------------------------------------------------------------+ ''' if type(signal) is not enums.Signal: raise TypeError('Parameter signal must be of type ' + str(enums.Signal)) - if type(signal_identifier) is not enums.SignalIdentifier: - raise TypeError('Parameter signal_identifier must be of type ' + str(enums.SignalIdentifier)) - if type(output_terminal) is not enums.ReferenceClockExportOutputTerminal: - raise TypeError('Parameter output_terminal must be of type ' + str(enums.ReferenceClockExportOutputTerminal)) self._interpreter.export_signal(signal, signal_identifier, output_terminal) + @ivi_synchronized + def get_all_named_waveform_names(self): + r'''get_all_named_waveform_names + + Return names of the waveforms present in the memory. + + **Supported Devices** :PXIe-5830/5831/5840/5841/5842E + + Returns: + waveform_names (str): Returns a string having waveform names separated by commas. + + actual_buffer_size (int): Fetch the number of bytes needed to pass in the BUFFER_SIZE parameter. + + It can be fetch by passing VI_NULL in the WAVEFORM_NAMES parameter. + + Note: + One or more of the referenced properties are not in the Python API for this driver. + + ''' + waveform_names, actual_buffer_size = self._interpreter.get_all_named_waveform_names() + return _converters.convert_comma_separated_string_to_list(waveform_names), actual_buffer_size + + @ivi_synchronized + def get_all_script_names(self): + r'''get_all_script_names + + Return names of the scripts present in the memory. + + **Supported Devices** :PXIe-5830/5831/5840/5841/5842E + + Returns: + script_names (str): Returns a string having script names separated by commas. + + actual_buffer_size (int): Fetch the number of bytes needed to pass in the BUFFER_SIZE parameter. + + It can be fetch by passing VI_NULL in the SCRIPT_NAMES parameter. + + Note: + One or more of the referenced properties are not in the Python API for this driver. + + ''' + script_names, actual_buffer_size = self._interpreter.get_all_script_names() + return script_names, actual_buffer_size + + @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_external_calibration_last_date_and_time(self): r'''_get_external_calibration_last_date_and_time @@ -7430,6 +7317,7 @@ def _get_external_calibration_last_date_and_time(self): year, month, day, hour, minute, second = self._interpreter.get_external_calibration_last_date_and_time() return year, month, day, hour, minute, second + @ivi_synchronized def get_external_calibration_last_date_and_time(self): '''get_external_calibration_last_date_and_time @@ -7442,6 +7330,7 @@ def get_external_calibration_last_date_and_time(self): year, month, day, hour, minute, second = self._get_external_calibration_last_date_and_time() return hightime.datetime(year, month, day, hour, minute) + @ivi_synchronized def get_self_calibration_last_date_and_time(self): '''get_self_calibration_last_date_and_time @@ -7454,6 +7343,7 @@ def get_self_calibration_last_date_and_time(self): year, month, day, hour, minute, second = self._get_self_calibration_date_and_time() return hightime.datetime(year, month, day, hour, minute) + @ivi_synchronized def get_max_settable_power(self): r'''get_max_settable_power @@ -7468,6 +7358,7 @@ def get_max_settable_power(self): value = self._interpreter.get_max_settable_power() return value + @ivi_synchronized def _get_self_calibration_date_and_time(self, module): r'''_get_self_calibration_date_and_time @@ -7502,6 +7393,7 @@ def _get_self_calibration_date_and_time(self, module): year, month, day, hour, minute, second = self._interpreter.get_self_calibration_date_and_time(module) return year, month, day, hour, minute, second + @ivi_synchronized def get_self_calibration_temperature(self, module): r'''get_self_calibration_temperature @@ -7534,6 +7426,7 @@ def get_self_calibration_temperature(self, module): temperature = self._interpreter.get_self_calibration_temperature(module) return temperature + @ivi_synchronized def get_stream_endpoint_handle(self, stream_endpoint): r'''get_stream_endpoint_handle @@ -7558,12 +7451,94 @@ def get_stream_endpoint_handle(self, stream_endpoint): reader_handle = self._interpreter.get_stream_endpoint_handle(stream_endpoint) return reader_handle - def _init_with_options(self, resource_name, id_query, reset_device, option_string): + @ivi_synchronized + def get_terminal_name(self, signal, signal_identifier): + r'''get_terminal_name + + Returns the fully-qualified name of the specified signal. + + The fully-qualified name is helpful to automatically route signals in a multisegment chassis. + + **Supported Devices** : PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + + **Related Topics** + + `Triggers `_ + + `Events `_ + + `Syntax for Terminal Names `_ + + Args: + signal (enums.Signal): Specifies the signal to query. **Defined Values** : + + +----------------------------------------+---------+--------------------------------------------+ + | Name | Value | Description | + +========================================+=========+============================================+ + | Signal.START_TRIGGER | 0 (0x0) | Exports a Start Trigger. | + +----------------------------------------+---------+--------------------------------------------+ + | Signal.SCRIPT_TRIGGER | 1 (0x1) | Exports a Script Trigger. | + +----------------------------------------+---------+--------------------------------------------+ + | Signal.MARKER_EVENT | 2 (0x2) | Exports a Marker Event. | + +----------------------------------------+---------+--------------------------------------------+ + | Signal.REF_CLOCK | 3 (0x3) | Exports the Reference Clock. | + +----------------------------------------+---------+--------------------------------------------+ + | Signal.STARTED_EVENT | 4 (0x4) | Exports a Started Event. | + +----------------------------------------+---------+--------------------------------------------+ + | Signal.DONE_EVENT | 5 (0x5) | Exports a Done Event. | + +----------------------------------------+---------+--------------------------------------------+ + | Signal.CONFIGURATION_LIST_STEP_TRIGGER | 6 (0x6) | Exports a Configuration List Step Trigger. | + +----------------------------------------+---------+--------------------------------------------+ + | Signal.CONFIGURATION_SETTLED_EVENT | 7 (0x7) | Exports a Configuration Settled Event. | + +----------------------------------------+---------+--------------------------------------------+ + + Note: + One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. + + signal_identifier (str): Specifies which instance of the selected signal to query. This parameter is necessary when you set the SIGNAL parameter to NIRFSG_VAL_SCRIPT_TRIGGER or NIRFSG_VAL_MARKER_EVENT . Otherwise, set the SIGNAL_IDENTIFIER parameter to '' (empty string). **Possible Values** : + + +----------------+-----------------------------+ + | Possible Value | Description | + +================+=============================+ + | marker0 | Specifies Marker 0. | + +----------------+-----------------------------+ + | marker1 | Specifies Marker 1. | + +----------------+-----------------------------+ + | marker2 | Specifies Marker 2. | + +----------------+-----------------------------+ + | marker3 | Specifies Marker 3. | + +----------------+-----------------------------+ + | scriptTrigger0 | Specifies Script Trigger 0. | + +----------------+-----------------------------+ + | scriptTrigger1 | Specifies Script Trigger 1. | + +----------------+-----------------------------+ + | scriptTrigger2 | Specifies Script Trigger 2. | + +----------------+-----------------------------+ + | scriptTrigger3 | Specifies Script Trigger 3. | + +----------------+-----------------------------+ + + Note: + One or more of the referenced properties are not in the Python API for this driver. + + 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. + + + Returns: + terminal_name (str): Returns the string to use as the source for other devices. + + ''' + if type(signal) is not enums.Signal: + raise TypeError('Parameter signal must be of type ' + str(enums.Signal)) + terminal_name = self._interpreter.get_terminal_name(signal, signal_identifier) + return terminal_name + + def _init_with_options(self, resource_name, option_string, id_query=False, reset_device=False): r'''_init_with_options - Opens a session to the device you specify as the **RESOURCE_NAME** and returns a ViSession handle that you use to identify the NI-RFSG device in all subsequent NI-RFSG method calls. + Opens a session to the device you specify as the RESOURCE_NAME and returns a ViSession handle that you use to identify the NI-RFSG device in all subsequent NI-RFSG method calls. - This method also configures the device through the **OPTION_STRING** input. + This method also configures the device through the OPTION_STRING input. **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -7585,30 +7560,6 @@ def _init_with_options(self, resource_name, id_query, reset_device, option_strin Note: NI-RFSG device names are not case-sensitive. However, all IVI names, such as logical names, are case-sensitive. If you use an IVI logical name, make sure the name is identical to the name shown in the IVI Configuration Utility. - id_query (bool): Specifies whether you want NI-RFSG to perform an ID query. - - **Defined Values** : - - +-----------+--------------------------+ - | Value | Description | - +===========+==========================+ - | True (1) | Perform ID query. | - +-----------+--------------------------+ - | False (0) | Do not perform ID query. | - +-----------+--------------------------+ - - reset_device (bool): Specifies whether you want to reset the NI-RFSG device during the initialization procedure. - - **Defined Values** : - - +-----------+----------------------+ - | Value | Description | - +===========+======================+ - | True (1) | Reset device. | - +-----------+----------------------+ - | False (0) | Do not reset device. | - +-----------+----------------------+ - option_string (str): Specifies the initial value of certain properties for the session. The following table lists the properties and the name you pass in this parameter to identify the property. The format of this string consists of the following relations: @@ -7635,6 +7586,30 @@ def _init_with_options(self, resource_name, id_query, reset_device, option_strin | Simulate | simulate | +------------------+-------------------------+ + id_query (bool): Specifies whether you want NI-RFSG to perform an ID query. + + **Defined Values** : + + +-----------+--------------------------+ + | Value | Description | + +===========+==========================+ + | True (1) | Perform ID query. | + +-----------+--------------------------+ + | False (0) | Do not perform ID query. | + +-----------+--------------------------+ + + reset_device (bool): Specifies whether you want to reset the NI-RFSG device during the initialization procedure. + + **Defined Values** : + + +-----------+----------------------+ + | Value | Description | + +===========+======================+ + | True (1) | Reset device. | + +-----------+----------------------+ + | False (0) | Do not reset device. | + +-----------+----------------------+ + Returns: new_vi (int): Returns a ViSession handle that you use to identify the NI-RFSG device in all subsequent NI-RFSG method calls. @@ -7643,6 +7618,7 @@ def _init_with_options(self, resource_name, id_query, reset_device, option_strin new_vi = self._interpreter.init_with_options(resource_name, id_query, reset_device, option_string) return new_vi + @ivi_synchronized def _initiate(self): r'''_initiate @@ -7658,6 +7634,7 @@ def _initiate(self): ''' self._interpreter.initiate() + @ivi_synchronized def perform_power_search(self): r'''perform_power_search @@ -7675,6 +7652,7 @@ def perform_power_search(self): ''' self._interpreter.perform_power_search() + @ivi_synchronized def perform_thermal_correction(self): r'''perform_thermal_correction @@ -7694,6 +7672,7 @@ def perform_thermal_correction(self): ''' self._interpreter.perform_thermal_correction() + @ivi_synchronized def query_arb_waveform_capabilities(self): r'''query_arb_waveform_capabilities @@ -7716,6 +7695,7 @@ def query_arb_waveform_capabilities(self): max_number_waveforms, waveform_quantum, min_waveform_size, max_waveform_size = self._interpreter.query_arb_waveform_capabilities() return max_number_waveforms, waveform_quantum, min_waveform_size, max_waveform_size + @ivi_synchronized def read_and_download_waveform_from_file_tdms(self, waveform_name, file_path, waveform_index): r'''read_and_download_waveform_from_file_tdms @@ -7752,6 +7732,7 @@ def read_and_download_waveform_from_file_tdms(self, waveform_name, file_path, wa ''' self._interpreter.read_and_download_waveform_from_file_tdms(waveform_name, file_path, waveform_index) + @ivi_synchronized def reset(self): r'''reset @@ -7761,7 +7742,7 @@ def reset(self): Generally, calling this method instead of the reset_device method is acceptable. The reset method executes faster than the reset_device method. - To avoid resetting routes on the PXIe-5644/5645/5646 and PXIe-5820/5830/5831/5832/5840/5841/5842/5860 that are in use by NI-RFSA sessions, NI recommends using the ResetWithOptions method, with **stepsToOmit** set to ResetWithOptionsStepsToOmit.ROUTES . + To avoid resetting routes on the PXIe-5644/5645/5646 and PXIe-5820/5830/5831/5832/5840/5841/5842/5860 that are in use by NI-RFSA sessions, NI recommends using the reset_with_options method, with **stepsToOmit** set to ResetWithOptionsStepsToOmit.ROUTES . **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -7769,6 +7750,7 @@ def reset(self): ''' self._interpreter.reset() + @ivi_synchronized def reset_device(self): r'''reset_device @@ -7795,6 +7777,7 @@ def reset_device(self): ''' self._interpreter.reset_device() + @ivi_synchronized def reset_with_defaults(self): r'''reset_with_defaults @@ -7804,6 +7787,54 @@ def reset_with_defaults(self): ''' self._interpreter.reset_with_defaults() + @ivi_synchronized + def reset_with_options(self, steps_to_omit): + r'''reset_with_options + + Resets all properties to default values and specifies steps to omit during the reset process, such as signal routes. + + By default, this method exhibits the same behavior as reset. You can specify steps to omit using the steps to omit parameter. For example, if you specify ResetWithOptionsStepsToOmit.ROUTES for the STEPS_TO_OMIT parameter, this method does not release signal routes during the reset process. + + When routes of signals between two devices are released, they are released regardless of which device created the route. + + To avoid resetting routes on PXIe-5820/5830/5831/5832/5840/5841/5842/5860 that are in use by NI-RFSA sessions, NI recommends using this method instead of reset, with STEPS_TO_OMIT set to ResetWithOptionsStepsToOmit.ROUTES. + + **Supported Devices** : PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + + **Related Topics** + + `Triggers `_ + + `Events `_ + + Note: + One or more of the referenced properties are not in the Python API for this driver. + + Args: + steps_to_omit (enums.ResetWithOptionsStepsToOmit): Specifies a list of steps to skip during the reset process. The default value is ResetWithOptionsStepsToOmit.NONE, which specifies that no step is omitted during reset. **Defined Values** : + + +------------------------------------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Value | Description | + +================================================+=========+============================================================================================================================================================================================================+ + | ResetWithOptionsStepsToOmit.NONE | 0 (0x0) | No step is omitted during reset. | + +------------------------------------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ResetWithOptionsStepsToOmit.WAVEFORMS | 1 (0x1) | Omits clearing waveforms. | + +------------------------------------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ResetWithOptionsStepsToOmit.SCRIPTS | 2 (0x2) | Omits clearing scripts. | + +------------------------------------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ResetWithOptionsStepsToOmit.ROUTES | 4 (0x4) | Omits the routing reset step. Routing is preserved after a reset. However, routing related properties are reset to default, and routing is released if the default properties are committed after a reset. | + +------------------------------------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ResetWithOptionsStepsToOmit.DEEMBEDDING_TABLES | 8 (0x8) | Omits deleting de-embedding tables. This step is valid only for the PXIe-5830/5831/5832/5840. | + +------------------------------------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + Note: ResetWithOptionsStepsToOmit.ROUTES is not supported in external calibration or alignment sessions. + + ''' + if type(steps_to_omit) is not enums.ResetWithOptionsStepsToOmit: + raise TypeError('Parameter steps_to_omit must be of type ' + str(enums.ResetWithOptionsStepsToOmit)) + self._interpreter.reset_with_options(steps_to_omit) + + @ivi_synchronized def select_arb_waveform(self, name): r'''select_arb_waveform @@ -7826,6 +7857,7 @@ def select_arb_waveform(self, name): ''' self._interpreter.select_arb_waveform(name) + @ivi_synchronized def self_cal(self): r'''self_cal @@ -7841,6 +7873,7 @@ def self_cal(self): ''' self._interpreter.self_cal() + @ivi_synchronized def self_calibrate_range(self, steps_to_omit, min_frequency, max_frequency, min_power_level, max_power_level): r'''self_calibrate_range @@ -7899,6 +7932,7 @@ def self_calibrate_range(self, steps_to_omit, min_frequency, max_frequency, min_ raise TypeError('Parameter steps_to_omit must be of type ' + str(enums.SelfCalibrateRangeStepsToOmit)) self._interpreter.self_calibrate_range(steps_to_omit, min_frequency, max_frequency, min_power_level, max_power_level) + @ivi_synchronized def self_test(self, self_test_message): r'''self_test @@ -7935,6 +7969,7 @@ def self_test(self, self_test_message): self_test_result = self._interpreter.self_test(self_test_message) return self_test_result + @ivi_synchronized def set_arb_waveform_next_write_position(self, waveform_name, relative_to, offset): r'''set_arb_waveform_next_write_position @@ -7971,6 +8006,7 @@ def set_arb_waveform_next_write_position(self, waveform_name, relative_to, offse raise TypeError('Parameter relative_to must be of type ' + str(enums.RelativeTo)) self._interpreter.set_arb_waveform_next_write_position(waveform_name, relative_to, offset) + @ivi_synchronized def wait_until_settled(self, max_time_milliseconds): r'''wait_until_settled @@ -7990,6 +8026,7 @@ def wait_until_settled(self, max_time_milliseconds): ''' self._interpreter.wait_until_settled(max_time_milliseconds) + @ivi_synchronized def write_p2_p_endpoint_i16(self, stream_endpoint, number_of_samples, endpoint_data): r'''write_p2_p_endpoint_i16 @@ -8019,6 +8056,7 @@ def write_p2_p_endpoint_i16(self, stream_endpoint, number_of_samples, endpoint_d ''' self._interpreter.write_p2_p_endpoint_i16(stream_endpoint, number_of_samples, endpoint_data) + @ivi_synchronized def write_script(self, script): r'''write_script diff --git a/generated/nirfsg/nirfsg/unit_tests/_mock_helper.py b/generated/nirfsg/nirfsg/unit_tests/_mock_helper.py index e7a01aadd..14f91d423 100644 --- a/generated/nirfsg/nirfsg/unit_tests/_mock_helper.py +++ b/generated/nirfsg/nirfsg/unit_tests/_mock_helper.py @@ -101,6 +101,14 @@ def __init__(self): self._defaults['DisableStartTrigger']['return'] = 0 self._defaults['ExportSignal'] = {} self._defaults['ExportSignal']['return'] = 0 + self._defaults['GetAllNamedWaveformNames'] = {} + self._defaults['GetAllNamedWaveformNames']['return'] = 0 + self._defaults['GetAllNamedWaveformNames']['actualBufferSize'] = None + self._defaults['GetAllNamedWaveformNames']['waveformNames'] = None + self._defaults['GetAllScriptNames'] = {} + self._defaults['GetAllScriptNames']['return'] = 0 + self._defaults['GetAllScriptNames']['actualBufferSize'] = None + self._defaults['GetAllScriptNames']['scriptNames'] = None self._defaults['GetAttributeViBoolean'] = {} self._defaults['GetAttributeViBoolean']['return'] = 0 self._defaults['GetAttributeViBoolean']['value'] = None @@ -119,6 +127,9 @@ 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['GetError'] = {} self._defaults['GetError']['return'] = 0 self._defaults['GetError']['errorCode'] = None @@ -148,18 +159,9 @@ def __init__(self): self._defaults['GetStreamEndpointHandle'] = {} self._defaults['GetStreamEndpointHandle']['return'] = 0 self._defaults['GetStreamEndpointHandle']['readerHandle'] = None - self._defaults['GetWaveformBurstStartLocations'] = {} - self._defaults['GetWaveformBurstStartLocations']['return'] = 0 - self._defaults['GetWaveformBurstStartLocations']['locations'] = None - self._defaults['GetWaveformBurstStartLocations']['requiredSize'] = None - self._defaults['GetWaveformBurstStopLocations'] = {} - self._defaults['GetWaveformBurstStopLocations']['return'] = 0 - self._defaults['GetWaveformBurstStopLocations']['locations'] = None - self._defaults['GetWaveformBurstStopLocations']['requiredSize'] = None - self._defaults['GetWaveformMarkerEventLocations'] = {} - self._defaults['GetWaveformMarkerEventLocations']['return'] = 0 - self._defaults['GetWaveformMarkerEventLocations']['locations'] = None - self._defaults['GetWaveformMarkerEventLocations']['requiredSize'] = None + self._defaults['GetTerminalName'] = {} + self._defaults['GetTerminalName']['return'] = 0 + self._defaults['GetTerminalName']['terminalName'] = None self._defaults['InitWithOptions'] = {} self._defaults['InitWithOptions']['return'] = 0 self._defaults['InitWithOptions']['newVi'] = None @@ -190,6 +192,8 @@ def __init__(self): self._defaults['ResetDevice']['return'] = 0 self._defaults['ResetWithDefaults'] = {} self._defaults['ResetWithDefaults']['return'] = 0 + self._defaults['ResetWithOptions'] = {} + self._defaults['ResetWithOptions']['return'] = 0 self._defaults['SaveConfigurationsToFile'] = {} self._defaults['SaveConfigurationsToFile']['return'] = 0 self._defaults['SelectArbWaveform'] = {} @@ -217,15 +221,6 @@ def __init__(self): self._defaults['SetAttributeViSession']['return'] = 0 self._defaults['SetAttributeViString'] = {} self._defaults['SetAttributeViString']['return'] = 0 - self._defaults['SetWaveformBurstStartLocations'] = {} - self._defaults['SetWaveformBurstStartLocations']['return'] = 0 - self._defaults['SetWaveformBurstStartLocations']['locations'] = None - self._defaults['SetWaveformBurstStopLocations'] = {} - self._defaults['SetWaveformBurstStopLocations']['return'] = 0 - self._defaults['SetWaveformBurstStopLocations']['locations'] = None - self._defaults['SetWaveformMarkerEventLocations'] = {} - self._defaults['SetWaveformMarkerEventLocations']['return'] = 0 - self._defaults['SetWaveformMarkerEventLocations']['locations'] = None self._defaults['UnlockSession'] = {} self._defaults['UnlockSession']['return'] = 0 self._defaults['UnlockSession']['callerHasLock'] = None @@ -464,6 +459,38 @@ def niRFSG_ExportSignal(self, vi, signal, signal_identifier, output_terminal): return self._defaults['ExportSignal']['return'] return self._defaults['ExportSignal']['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'] + # actual_buffer_size + if self._defaults['GetAllNamedWaveformNames']['actualBufferSize'] is None: + raise MockFunctionCallError("niRFSG_GetAllNamedWaveformNames", param='actualBufferSize') + if actual_buffer_size is not None: + actual_buffer_size.contents.value = self._defaults['GetAllNamedWaveformNames']['actualBufferSize'] + # waveform_names + if self._defaults['GetAllNamedWaveformNames']['waveformNames'] is None: + raise MockFunctionCallError("niRFSG_GetAllNamedWaveformNames", param='waveformNames') + if buffer_size.value == 0: + return len(self._defaults['GetAllNamedWaveformNames']['waveformNames']) + waveform_names.value = self._defaults['GetAllNamedWaveformNames']['waveformNames'].encode('ascii') + return self._defaults['GetAllNamedWaveformNames']['return'] + + def niRFSG_GetAllScriptNames(self, vi, script_names, buffer_size, actual_buffer_size): # noqa: N802 + if self._defaults['GetAllScriptNames']['return'] != 0: + return self._defaults['GetAllScriptNames']['return'] + # actual_buffer_size + if self._defaults['GetAllScriptNames']['actualBufferSize'] is None: + raise MockFunctionCallError("niRFSG_GetAllScriptNames", param='actualBufferSize') + if actual_buffer_size is not None: + actual_buffer_size.contents.value = self._defaults['GetAllScriptNames']['actualBufferSize'] + # script_names + if self._defaults['GetAllScriptNames']['scriptNames'] is None: + raise MockFunctionCallError("niRFSG_GetAllScriptNames", param='scriptNames') + if buffer_size.value == 0: + return len(self._defaults['GetAllScriptNames']['scriptNames']) + script_names.value = self._defaults['GetAllScriptNames']['scriptNames'].encode('ascii') + return self._defaults['GetAllScriptNames']['return'] + def niRFSG_GetAttributeViBoolean(self, vi, channel_name, attribute, value): # noqa: N802 if self._defaults['GetAttributeViBoolean']['return'] != 0: return self._defaults['GetAttributeViBoolean']['return'] @@ -525,6 +552,17 @@ 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_GetError(self, vi, error_code, error_description_buffer_size, error_description): # noqa: N802 if self._defaults['GetError']['return'] != 0: return self._defaults['GetError']['return'] @@ -641,50 +679,16 @@ def niRFSG_GetStreamEndpointHandle(self, vi, stream_endpoint, reader_handle): # reader_handle.contents.value = self._defaults['GetStreamEndpointHandle']['readerHandle'] return self._defaults['GetStreamEndpointHandle']['return'] - def niRFSG_GetWaveformBurstStartLocations(self, vi, channel_name, number_of_locations, locations, required_size): # noqa: N802 - if self._defaults['GetWaveformBurstStartLocations']['return'] != 0: - return self._defaults['GetWaveformBurstStartLocations']['return'] - # locations - if self._defaults['GetWaveformBurstStartLocations']['locations'] is None: - raise MockFunctionCallError("niRFSG_GetWaveformBurstStartLocations", param='locations') - if locations is not None: - locations.contents.value = self._defaults['GetWaveformBurstStartLocations']['locations'] - # required_size - if self._defaults['GetWaveformBurstStartLocations']['requiredSize'] is None: - raise MockFunctionCallError("niRFSG_GetWaveformBurstStartLocations", param='requiredSize') - if required_size is not None: - required_size.contents.value = self._defaults['GetWaveformBurstStartLocations']['requiredSize'] - return self._defaults['GetWaveformBurstStartLocations']['return'] - - def niRFSG_GetWaveformBurstStopLocations(self, vi, channel_name, number_of_locations, locations, required_size): # noqa: N802 - if self._defaults['GetWaveformBurstStopLocations']['return'] != 0: - return self._defaults['GetWaveformBurstStopLocations']['return'] - # locations - if self._defaults['GetWaveformBurstStopLocations']['locations'] is None: - raise MockFunctionCallError("niRFSG_GetWaveformBurstStopLocations", param='locations') - if locations is not None: - locations.contents.value = self._defaults['GetWaveformBurstStopLocations']['locations'] - # required_size - if self._defaults['GetWaveformBurstStopLocations']['requiredSize'] is None: - raise MockFunctionCallError("niRFSG_GetWaveformBurstStopLocations", param='requiredSize') - if required_size is not None: - required_size.contents.value = self._defaults['GetWaveformBurstStopLocations']['requiredSize'] - return self._defaults['GetWaveformBurstStopLocations']['return'] - - def niRFSG_GetWaveformMarkerEventLocations(self, vi, channel_name, number_of_locations, locations, required_size): # noqa: N802 - if self._defaults['GetWaveformMarkerEventLocations']['return'] != 0: - return self._defaults['GetWaveformMarkerEventLocations']['return'] - # locations - if self._defaults['GetWaveformMarkerEventLocations']['locations'] is None: - raise MockFunctionCallError("niRFSG_GetWaveformMarkerEventLocations", param='locations') - if locations is not None: - locations.contents.value = self._defaults['GetWaveformMarkerEventLocations']['locations'] - # required_size - if self._defaults['GetWaveformMarkerEventLocations']['requiredSize'] is None: - raise MockFunctionCallError("niRFSG_GetWaveformMarkerEventLocations", param='requiredSize') - if required_size is not None: - required_size.contents.value = self._defaults['GetWaveformMarkerEventLocations']['requiredSize'] - return self._defaults['GetWaveformMarkerEventLocations']['return'] + def niRFSG_GetTerminalName(self, vi, signal, signal_identifier, buffer_size, terminal_name): # noqa: N802 + if self._defaults['GetTerminalName']['return'] != 0: + return self._defaults['GetTerminalName']['return'] + # terminal_name + if self._defaults['GetTerminalName']['terminalName'] is None: + raise MockFunctionCallError("niRFSG_GetTerminalName", param='terminalName') + if buffer_size.value == 0: + return len(self._defaults['GetTerminalName']['terminalName']) + terminal_name.value = self._defaults['GetTerminalName']['terminalName'].encode('ascii') + return self._defaults['GetTerminalName']['return'] def niRFSG_InitWithOptions(self, resource_name, id_query, reset_device, option_string, new_vi): # noqa: N802 if self._defaults['InitWithOptions']['return'] != 0: @@ -776,6 +780,11 @@ def niRFSG_ResetWithDefaults(self, vi): # noqa: N802 return self._defaults['ResetWithDefaults']['return'] return self._defaults['ResetWithDefaults']['return'] + def niRFSG_ResetWithOptions(self, vi, steps_to_omit): # noqa: N802 + if self._defaults['ResetWithOptions']['return'] != 0: + return self._defaults['ResetWithOptions']['return'] + return self._defaults['ResetWithOptions']['return'] + def niRFSG_SaveConfigurationsToFile(self, vi, channel_name, file_path): # noqa: N802 if self._defaults['SaveConfigurationsToFile']['return'] != 0: return self._defaults['SaveConfigurationsToFile']['return'] @@ -846,36 +855,6 @@ def niRFSG_SetAttributeViString(self, vi, channel_name, attribute, value): # no return self._defaults['SetAttributeViString']['return'] return self._defaults['SetAttributeViString']['return'] - def niRFSG_SetWaveformBurstStartLocations(self, vi, channel_name, number_of_locations, locations): # noqa: N802 - if self._defaults['SetWaveformBurstStartLocations']['return'] != 0: - return self._defaults['SetWaveformBurstStartLocations']['return'] - # locations - if self._defaults['SetWaveformBurstStartLocations']['locations'] is None: - raise MockFunctionCallError("niRFSG_SetWaveformBurstStartLocations", param='locations') - if locations is not None: - locations.contents.value = self._defaults['SetWaveformBurstStartLocations']['locations'] - return self._defaults['SetWaveformBurstStartLocations']['return'] - - def niRFSG_SetWaveformBurstStopLocations(self, vi, channel_name, number_of_locations, locations): # noqa: N802 - if self._defaults['SetWaveformBurstStopLocations']['return'] != 0: - return self._defaults['SetWaveformBurstStopLocations']['return'] - # locations - if self._defaults['SetWaveformBurstStopLocations']['locations'] is None: - raise MockFunctionCallError("niRFSG_SetWaveformBurstStopLocations", param='locations') - if locations is not None: - locations.contents.value = self._defaults['SetWaveformBurstStopLocations']['locations'] - return self._defaults['SetWaveformBurstStopLocations']['return'] - - def niRFSG_SetWaveformMarkerEventLocations(self, vi, channel_name, number_of_locations, locations): # noqa: N802 - if self._defaults['SetWaveformMarkerEventLocations']['return'] != 0: - return self._defaults['SetWaveformMarkerEventLocations']['return'] - # locations - if self._defaults['SetWaveformMarkerEventLocations']['locations'] is None: - raise MockFunctionCallError("niRFSG_SetWaveformMarkerEventLocations", param='locations') - if locations is not None: - locations.contents.value = self._defaults['SetWaveformMarkerEventLocations']['locations'] - return self._defaults['SetWaveformMarkerEventLocations']['return'] - def niRFSG_UnlockSession(self, vi, caller_has_lock): # noqa: N802 if self._defaults['UnlockSession']['return'] != 0: return self._defaults['UnlockSession']['return'] @@ -990,6 +969,10 @@ def set_side_effects_and_return_values(self, mock_library): mock_library.niRFSG_DisableStartTrigger.return_value = 0 mock_library.niRFSG_ExportSignal.side_effect = MockFunctionCallError("niRFSG_ExportSignal") mock_library.niRFSG_ExportSignal.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") + mock_library.niRFSG_GetAllScriptNames.return_value = 0 mock_library.niRFSG_GetAttributeViBoolean.side_effect = MockFunctionCallError("niRFSG_GetAttributeViBoolean") mock_library.niRFSG_GetAttributeViBoolean.return_value = 0 mock_library.niRFSG_GetAttributeViInt32.side_effect = MockFunctionCallError("niRFSG_GetAttributeViInt32") @@ -1002,6 +985,8 @@ 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_GetError.side_effect = MockFunctionCallError("niRFSG_GetError") mock_library.niRFSG_GetError.return_value = 0 mock_library.niRFSG_GetExternalCalibrationLastDateAndTime.side_effect = MockFunctionCallError("niRFSG_GetExternalCalibrationLastDateAndTime") @@ -1014,12 +999,8 @@ def set_side_effects_and_return_values(self, mock_library): mock_library.niRFSG_GetSelfCalibrationTemperature.return_value = 0 mock_library.niRFSG_GetStreamEndpointHandle.side_effect = MockFunctionCallError("niRFSG_GetStreamEndpointHandle") mock_library.niRFSG_GetStreamEndpointHandle.return_value = 0 - mock_library.niRFSG_GetWaveformBurstStartLocations.side_effect = MockFunctionCallError("niRFSG_GetWaveformBurstStartLocations") - mock_library.niRFSG_GetWaveformBurstStartLocations.return_value = 0 - mock_library.niRFSG_GetWaveformBurstStopLocations.side_effect = MockFunctionCallError("niRFSG_GetWaveformBurstStopLocations") - mock_library.niRFSG_GetWaveformBurstStopLocations.return_value = 0 - mock_library.niRFSG_GetWaveformMarkerEventLocations.side_effect = MockFunctionCallError("niRFSG_GetWaveformMarkerEventLocations") - mock_library.niRFSG_GetWaveformMarkerEventLocations.return_value = 0 + mock_library.niRFSG_GetTerminalName.side_effect = MockFunctionCallError("niRFSG_GetTerminalName") + mock_library.niRFSG_GetTerminalName.return_value = 0 mock_library.niRFSG_InitWithOptions.side_effect = MockFunctionCallError("niRFSG_InitWithOptions") mock_library.niRFSG_InitWithOptions.return_value = 0 mock_library.niRFSG_Initiate.side_effect = MockFunctionCallError("niRFSG_Initiate") @@ -1044,6 +1025,8 @@ def set_side_effects_and_return_values(self, mock_library): 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_SaveConfigurationsToFile.side_effect = MockFunctionCallError("niRFSG_SaveConfigurationsToFile") mock_library.niRFSG_SaveConfigurationsToFile.return_value = 0 mock_library.niRFSG_SelectArbWaveform.side_effect = MockFunctionCallError("niRFSG_SelectArbWaveform") @@ -1070,12 +1053,6 @@ def set_side_effects_and_return_values(self, mock_library): mock_library.niRFSG_SetAttributeViSession.return_value = 0 mock_library.niRFSG_SetAttributeViString.side_effect = MockFunctionCallError("niRFSG_SetAttributeViString") mock_library.niRFSG_SetAttributeViString.return_value = 0 - mock_library.niRFSG_SetWaveformBurstStartLocations.side_effect = MockFunctionCallError("niRFSG_SetWaveformBurstStartLocations") - mock_library.niRFSG_SetWaveformBurstStartLocations.return_value = 0 - mock_library.niRFSG_SetWaveformBurstStopLocations.side_effect = MockFunctionCallError("niRFSG_SetWaveformBurstStopLocations") - mock_library.niRFSG_SetWaveformBurstStopLocations.return_value = 0 - mock_library.niRFSG_SetWaveformMarkerEventLocations.side_effect = MockFunctionCallError("niRFSG_SetWaveformMarkerEventLocations") - mock_library.niRFSG_SetWaveformMarkerEventLocations.return_value = 0 mock_library.niRFSG_UnlockSession.side_effect = MockFunctionCallError("niRFSG_UnlockSession") mock_library.niRFSG_UnlockSession.return_value = 0 mock_library.niRFSG_WaitUntilSettled.side_effect = MockFunctionCallError("niRFSG_WaitUntilSettled") diff --git a/src/nirfsg/metadata/attributes.py b/src/nirfsg/metadata/attributes.py index 2ef722a1a..d75d2dceb 100644 --- a/src/nirfsg/metadata/attributes.py +++ b/src/nirfsg/metadata/attributes.py @@ -281,47 +281,39 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the Reference Clock source. To set this attribute, the NI-RFSG device must be in the Configuration state. Only certain combinations of this attribute and the NIRFSG_ATTR_PXI_CHASSIS_CLK10_SOURCE attribute are valid, as shown in the following table.\n\n **Default Value:** NIRFSG_VAL_ONBOARD_CLOCK_STR\n\n **Supported Devices:** PXI-5610, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Timing Configurations `_\n \n **High-Level Functions**:\n\n - nirfsg_ConfigureRefClock\n \n **Defined Values**:\n ', + 'description': ' Specifies the Reference Clock source. To set this attribute, the NI-RFSG device must be in the Configuration state. Only certain combinations of this attribute and the NIRFSG_ATTR_PXI_CHASSIS_CLK10_SOURCE attribute are valid, as shown in the following table.\n\n **Default Value:** NIRFSG_VAL_ONBOARD_CLOCK_STR\n\n **Supported Devices:** PXI-5610, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Timing Configurations `_\n \n **High-Level Functions**:\n\n - nirfsg_ConfigureRefClock\n \n **Possible Values**:\n ', 'note': 'The PXI-5670/5671 and PXIe-5672 devices also allow you to drive the PXI 10 MHz backplane clock on PXI chassis *only* using the NIRFSG_ATTR_PXI_CHASSIS_CLK10_SOURCE attribute.', 'table_body': [ [ - 'NIRFSG_VAL_ONBOARD_CLOCK_STR', 'OnboardClock', 'Uses the onboard Reference Clock as the clock source. **PXIe-5830/5831** —For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831/5832, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. ** PXIe-5831/5832 with PXIe-5653** —Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector. **PXIe-5841 with PXIe-5655** —Lock to the PXIe-5655 onboard clock. Connect the REF OUT connector on the PXIe-5655 to the PXIe-5841 REF IN connector.' ], [ - 'NIRFSG_VAL_CLK_IN_STR', 'ClkIn', 'Uses the clock signal present at the front panel CLK IN connector as the Reference Clock source. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5831 with PXIe-5653/5832/5832 with PXIe-5653/5840/5841/5841 with PXIe-5655.' ], [ - 'NIRFSG_VAL_REF_IN_STR', 'RefIn', 'Uses the clock signal present at the front panel REF IN connector as the Reference Clock source. **PXIe-5830/5831** —For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831/5832, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. For the PXIe-5830, lock the external signal to the PXIe-3621 REF IN connector. For the PXIe-5831/5832, lock the external signal to the PXIe-3622 REF IN connector. **PXIe-5831/5832 with PXIe-5653** —Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector. Lock the external signal to the PXIe-5653 REF IN connector. **PXIe-5841 with PXIe-5655** —Lock to the signal at the REF IN connector on the associated PXIe-5655. Connect the PXIe-5655 REF OUT connector to the PXIe-5841 REF IN connector.' ], [ - 'NIRFSG_VAL_PXI_CLK_STR', 'PXI_CLK', 'Uses the PXI_CLK signal, which is present on the PXI backplane, as the Reference Clock source.' ], [ - 'NIRFSG_VAL_REF_IN_2_STR', 'RefIn2', 'This value is not valid on any supported devices.' ], [ - 'NIRFSG_VAL_PXI_CLK_MASTER_STR', 'PXI_ClkMaster', 'This value is valid on only the PXIe-5831/5832 with PXIe-5653. **PXIe-5831/5832 with PXIe-5653** —NI-RFSG configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3622 to use NIRFSG_VAL_PXI_CLK_STR as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector.' ] ], 'table_header': [ - 'Name', - 'Value', + 'Possible Value', 'Description' ] }, - 'enum': 'ReferenceClockSource', 'lv_property': 'Clock:Reference Clock Source', 'name': 'REF_CLOCK_SOURCE', 'type': 'ViString' @@ -330,136 +322,110 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the source terminal for the Start Trigger. This attribute is used when the NIRFSG_ATTR_START_TRIGGER_TYPE attribute is set to digital edge. The NIRFSG_ATTR_DIGITAL_EDGE_START_TRIGGER_SOURCE attribute is not case-sensitive. To set the NIRFSG_ATTR_DIGITAL_EDGE_START_TRIGGER_SOURCE attribute, the NI-RFSG device must be in the Configuration state.\n\n PXIe-5654/5654 with PXIe-5696: The Start Trigger is valid only with a timer-based list when RF list mode is enabled.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Start Trigger `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n \n **High-Level Functions**:\n\n - nirfsg_ConfigureDigitalEdgeStartTrigger\n \n **Defined Values**:\n ', + 'description': ' Specifies the source terminal for the Start Trigger. This attribute is used when the NIRFSG_ATTR_START_TRIGGER_TYPE attribute is set to digital edge. The NIRFSG_ATTR_DIGITAL_EDGE_START_TRIGGER_SOURCE attribute is not case-sensitive. To set the NIRFSG_ATTR_DIGITAL_EDGE_START_TRIGGER_SOURCE attribute, the NI-RFSG device must be in the Configuration state.\n\n PXIe-5654/5654 with PXIe-5696: The Start Trigger is valid only with a timer-based list when RF list mode is enabled.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Start Trigger `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n \n **High-Level Functions**:\n\n - nirfsg_ConfigureDigitalEdgeStartTrigger\n \n **Possible Values**:\n ', 'table_body': [ [ - 'NIRFSG_VAL_PFI0_STR', 'PFI0', 'The trigger is received on PFI 0.' ], [ - 'NIRFSG_VAL_PFI1_STR', 'PFI1', 'The trigger is received on PFI 1.' ], [ - 'NIRFSG_VAL_PFI2_STR', 'PFI2', 'The trigger is received on PFI 2.' ], [ - 'NIRFSG_VAL_PFI3_STR', 'PFI3', 'The trigger is received on PFI 3.' ], [ - 'NIRFSG_VAL_PXI_STAR_STR', 'PXI_Star', 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' ], [ - 'NIRFSG_VAL_PXI_TRIG0_STR', 'PXI_Trig0', 'The trigger is received on PXI trigger line 0.' ], [ - 'NIRFSG_VAL_PXI_TRIG1_STR', 'PXI_Trig1', 'The trigger is received on PXI trigger line 1.' ], [ - 'NIRFSG_VAL_PXI_TRIG2_STR', 'PXI_Trig2', 'The trigger is received on PXI trigger line 2.' ], [ - 'NIRFSG_VAL_PXI_TRIG3_STR', 'PXI_Trig3', 'The trigger is received on PXI trigger line 3.' ], [ - 'NIRFSG_VAL_PXI_TRIG4_STR', 'PXI_Trig4', 'The trigger is received on PXI trigger line 4.' ], [ - 'NIRFSG_VAL_PXI_TRIG5_STR', 'PXI_Trig5', 'The trigger is received on PXI trigger line 5.' ], [ - 'NIRFSG_VAL_PXI_TRIG6_STR', 'PXI_Trig6', 'The trigger is received on PXI trigger line 6.' ], [ - 'NIRFSG_VAL_PXI_TRIG7_STR', 'PXI_Trig7', 'The trigger is received on PXI trigger line 7.' ], [ - 'NIRFSG_VAL_PXIE_DSTARB_STR', 'PXIe_DStarB', 'The trigger is received on the PXI DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860.' ], [ - 'NIRFSG_VAL_TRIG_IN_STR', 'TrigIn', 'The trigger is received on the TRIG IN/OUT terminal. This value is valid on only the PXIe-5654/5654 with PXIe-5696.' ], [ - 'NIRFSG_VAL_DIO0_STR', 'DIO/PFI0', 'The trigger is received on PFI0 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO1_STR', 'DIO/PFI1', 'The trigger is received on PFI1 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO2_STR', 'DIO/PFI2', 'The trigger is received on PFI2 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO3_STR', 'DIO/PFI3', 'The trigger is received on PFI3 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO4_STR', 'DIO/PFI4', 'The trigger is received on PFI4 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO5_STR', 'DIO/PFI5', 'The trigger is received on PFI5 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO6_STR', 'DIO/PFI6', 'The trigger is received on PFI6 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO7_STR', 'DIO/PFI7', 'The trigger is received on PFI7 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_SYNC_SCRIPT_TRIGGER_STR', 'Sync_Script', 'The trigger is received on the Sync Script trigger line. This value is valid on only the PXIe-5644/5645/5646.' ] ], 'table_header': [ - 'Name', - 'Value', + 'Possible Value', 'Description' ] }, - 'enum': 'StartTrigDigEdgeSource', 'lv_property': 'Triggers:Start:Digital Edge:Source', 'name': 'DIGITAL_EDGE_START_TRIGGER_SOURCE', 'type': 'ViString' @@ -468,126 +434,102 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the destination terminal for exporting the Start Trigger. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n PXIe-5654/5654 with PXIe-5696: The Start Trigger is valid only with a timer-based list when RF list mode is enabled.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Start Trigger `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n \n **Defined Values**:\n ', + 'description': ' Specifies the destination terminal for exporting the Start Trigger. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n PXIe-5654/5654 with PXIe-5696: The Start Trigger is valid only with a timer-based list when RF list mode is enabled.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Start Trigger `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n \n **Possible Values**:\n ', 'table_body': [ [ - 'NIRFSG_VAL_DO_NOT_EXPORT_STR', - '', + 'empty', 'The signal is not exported.' ], [ - 'NIRFSG_VAL_PFI0_STR', 'PFI0', 'The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0.' ], [ - 'NIRFSG_VAL_PFI1_STR', 'PFI1', 'The signal is exported to the PFI 1 connector.' ], [ - 'NIRFSG_VAL_PFI4_STR', 'PFI4', 'The signal is exported to the PFI 4 connector.' ], [ - 'NIRFSG_VAL_PFI5_STR', 'PFI5', 'The signal is exported to the PFI 5 connector.' ], [ - 'NIRFSG_VAL_PXI_TRIG0_STR', 'PXI_Trig0', 'The trigger is received on PXI trigger line 0.' ], [ - 'NIRFSG_VAL_PXI_TRIG1_STR', 'PXI_Trig1', 'The trigger is received on PXI trigger line 1.' ], [ - 'NIRFSG_VAL_PXI_TRIG2_STR', 'PXI_Trig2', 'The trigger is received on PXI trigger line 2.' ], [ - 'NIRFSG_VAL_PXI_TRIG3_STR', 'PXI_Trig3', 'The trigger is received on PXI trigger line 3.' ], [ - 'NIRFSG_VAL_PXI_TRIG4_STR', 'PXI_Trig4', 'The trigger is received on PXI trigger line 4.' ], [ - 'NIRFSG_VAL_PXI_TRIG5_STR', 'PXI_Trig5', 'The trigger is received on PXI trigger line 5.' ], [ - 'NIRFSG_VAL_PXI_TRIG6_STR', 'PXI_Trig6', 'The trigger is received on PXI trigger line 6.' ], [ - 'NIRFSG_VAL_PXIE_DSTARC_STR', 'PXIe_DStarC', 'The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860.' ], [ - 'NIRFSG_VAL_TRIG_OUT_STR', 'TrigOut', 'The signal is exported to the TRIG IN/OUT terminal. This value is valid on only the PXIe-5654/5654 with PXIe-5696.' ], [ - 'NIRFSG_VAL_DIO0_STR', 'DIO/PFI0', 'The trigger is received on PFI0 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO1_STR', 'DIO/PFI1', 'The trigger is received on PFI1 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO2_STR', 'DIO/PFI2', 'The trigger is received on PFI2 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO3_STR', 'DIO/PFI3', 'The trigger is received on PFI3 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO4_STR', 'DIO/PFI4', 'The trigger is received on PFI4 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO5_STR', 'DIO/PFI5', 'The trigger is received on PFI5 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO6_STR', 'DIO/PFI6', 'The trigger is received on PFI6 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO7_STR', 'DIO/PFI7', 'The trigger is received on PFI7 from the front panel DIO terminal.' ] ], 'table_header': [ - 'Name', - 'Value', + 'Possible Value', 'Description' ] }, - 'enum': 'StartTrigExportOutputTerm', 'lv_property': 'Triggers:Start:Export Output Terminal', 'name': 'EXPORTED_START_TRIGGER_OUTPUT_TERMINAL', 'type': 'ViString' @@ -596,19 +538,19 @@ '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 **Defined Values**:\n\nName (Value): Description\n\nNIRFSG_VAL_NONE (0) :Do not drive the PXI_CLK10 signal.\n\nNIRFSG_VAL_ONBOARD_CLOCK_STR (OnboardClock) :Uses the highly stable oven-controlled onboard Reference Clock to drive the PXI_CLK signal.\n\nNIRFSG_VAL_REF_IN_STR (RefIn) :Uses the clock present at the front panel REF IN connector to drive the PXI_CLK signal.\n\n **Default Value:** NIRFSG_VAL_NONE\n\n **Supported Devices:** PXI-5610, PXI-5670/5671\n\n **Related Topics**\n\n `Timing Configurations `_\n\n `System Reference Clock `_\n \n **High-Level Functions**:\n\n - nirfsg_ConfigurePxiChassisClk10\n \n \n Only certain combinations of this attribute and the NIRFSG_ATTR_REF_CLOCK_SOURCE attribute are valid, as shown in the following table.\n ', + 'description': ' Specifies the clock source for driving the PXI 10 MHz backplane Reference Clock. This attribute is configurable if the PXI-5610 upconverter module is installed in *only* Slot 2 of a PXI chassis. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Possible Values**:\n\nPossible Value: Description\n\nempty :Do not drive the PXI_CLK10 signal.\n\nOnboardClock :Uses the highly stable oven-controlled onboard Reference Clock to drive the PXI_CLK signal.\n\nRefIn :Uses the clock present at the front panel REF IN connector to drive the PXI_CLK signal.\n\n **Default Value:** empty\n\n **Supported Devices:** PXI-5610, PXI-5670/5671\n\n **Related Topics**\n\n `Timing Configurations `_\n\n `System Reference Clock `_\n \n **High-Level Functions**:\n\n - nirfsg_ConfigurePxiChassisClk10\n \n \n Only certain combinations of this attribute and the NIRFSG_ATTR_REF_CLOCK_SOURCE attribute are valid, as shown in the following table.\n ', 'table_body': [ [ - 'NIRFSG_VAL_NONE, NIRFSG_VAL_ONBOARD_CLOCK_STR', - 'NIRFSG_VAL_ONBOARD_CLOCK_STR' + 'empty, OnboardClock', + 'OnboardClock' ], [ - 'NIRFSG_VAL_NONE, NIRFSG_VAL_REF_IN_STR', - 'NIRFSG_VAL_REF_IN_STR' + 'empty, RefIn', + 'RefIn' ], [ - 'NIRFSG_VAL_NONE, NIRFSG_VAL_REF_IN_STR', - 'NIRFSG_VAL_PXI_CLK_STR' + 'empty, RefIn', + 'PXI_CLK' ] ], 'table_header': [ @@ -616,7 +558,6 @@ 'NIRFSG_ATTR_REF_CLOCK_SOURCE Setting' ] }, - 'enum': 'PxiChassisClk10Source', 'lv_property': 'Clock:PXI Chassis Clk 10 Source', 'name': 'PXI_CHASSIS_CLK10_SOURCE', 'type': 'ViString' @@ -994,136 +935,110 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the source terminal for the Script Trigger. This attribute is used when the NIRFSG_ATTR_SCRIPT_TRIGGER_TYPE attribute is set to digital edge. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Script Trigger `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n \n **High-Level Functions**:\n\n - nirfsg_ConfigureDigitalEdgeScriptTrigger\n \n **Defined Values**:\n ', + 'description': ' Specifies the source terminal for the Script Trigger. This attribute is used when the NIRFSG_ATTR_SCRIPT_TRIGGER_TYPE attribute is set to digital edge. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Script Trigger `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n \n **High-Level Functions**:\n\n - nirfsg_ConfigureDigitalEdgeScriptTrigger\n \n **Possible Values**:\n ', 'table_body': [ [ - 'NIRFSG_VAL_PFI0_STR', 'PFI0', 'The trigger is received on PFI 0.' ], [ - 'NIRFSG_VAL_PFI1_STR', 'PFI1', 'The trigger is received on PFI 1.' ], [ - 'NIRFSG_VAL_PFI2_STR', 'PFI2', 'The trigger is received on PFI 2.' ], [ - 'NIRFSG_VAL_PFI3_STR', 'PFI3', 'The trigger is received on PFI 3.' ], [ - 'NIRFSG_VAL_PXI_STAR_STR', 'PXI_Star', 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' ], [ - 'NIRFSG_VAL_PXI_TRIG0_STR', 'PXI_Trig0', 'The trigger is received on PXI trigger line 0.' ], [ - 'NIRFSG_VAL_PXI_TRIG1_STR', 'PXI_Trig1', 'The trigger is received on PXI trigger line 1.' ], [ - 'NIRFSG_VAL_PXI_TRIG2_STR', 'PXI_Trig2', 'The trigger is received on PXI trigger line 2.' ], [ - 'NIRFSG_VAL_PXI_TRIG3_STR', 'PXI_Trig3', 'The trigger is received on PXI trigger line 3.' ], [ - 'NIRFSG_VAL_PXI_TRIG4_STR', 'PXI_Trig4', 'The trigger is received on PXI trigger line 4.' ], [ - 'NIRFSG_VAL_PXI_TRIG5_STR', 'PXI_Trig5', 'The trigger is received on PXI trigger line 5.' ], [ - 'NIRFSG_VAL_PXI_TRIG6_STR', 'PXI_Trig6', 'The trigger is received on PXI trigger line 6.' ], [ - 'NIRFSG_VAL_PXI_TRIG7_STR', 'PXI_Trig7', 'The trigger is received on PXI trigger line 7.' ], [ - 'NIRFSG_VAL_PXIE_DSTARB_STR', 'PXIe_DStarB', 'The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860.' ], [ - 'NIRFSG_VAL_PULSE_IN_STR', 'PulseIn', 'The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842.' ], [ - 'NIRFSG_VAL_DIO0_STR', 'DIO/PFI0', 'The trigger is received on PFI0 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO1_STR', 'DIO/PFI1', 'The trigger is received on PFI1 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO2_STR', 'DIO/PFI2', 'The trigger is received on PFI2 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO3_STR', 'DIO/PFI3', 'The trigger is received on PFI3 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO4_STR', 'DIO/PFI4', 'The trigger is received on PFI4 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO5_STR', 'DIO/PFI5', 'The trigger is received on PFI5 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO6_STR', 'DIO/PFI6', 'The trigger is received on PFI6 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO7_STR', 'DIO/PFI7', 'The trigger is received on PFI7 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_SYNC_SCRIPT_TRIGGER_STR', 'Sync_Script', 'The trigger is received on the Sync Script trigger line. This value is valid on only the PXIe-5644/5645/5646.' ] ], 'table_header': [ - 'Name', - 'Value', + 'Possible Value', 'Description' ] }, - 'enum': 'ScriptTrigDigEdgeSource', 'lv_property': 'Triggers:Script:Digital Edge:Source', 'name': 'DIGITAL_EDGE_SCRIPT_TRIGGER_SOURCE', 'supported_rep_caps': [ @@ -1166,121 +1081,98 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the destination terminal for exporting the Script Trigger. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Script Trigger `_ —Refer to this topic for information about trigger delay.\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n \n **High-Level Functions**:\n\n - nirfsg_ExportSignal\n \n **Defined Values**:\n ', + 'description': ' Specifies the destination terminal for exporting the Script Trigger. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Script Trigger `_ —Refer to this topic for information about trigger delay.\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n \n **High-Level Functions**:\n\n - nirfsg_ExportSignal\n \n **Possible Values**:\n ', 'table_body': [ [ - 'NIRFSG_VAL_DO_NOT_EXPORT_STR', - '', + 'empty', 'The signal is not exported.' ], [ - 'NIRFSG_VAL_PFI0_STR', 'PFI0', 'The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0.' ], [ - 'NIRFSG_VAL_PFI1_STR', 'PFI1', 'The signal is exported to the PFI 1 connector.' ], [ - 'NIRFSG_VAL_PFI4_STR', 'PFI4', 'The signal is exported to the PFI 4 connector.' ], [ - 'NIRFSG_VAL_PFI5_STR', 'PFI5', 'The signal is exported to the PFI 5 connector.' ], [ - 'NIRFSG_VAL_PXI_TRIG0_STR', 'PXI_Trig0', 'The trigger is received on PXI trigger line 0.' ], [ - 'NIRFSG_VAL_PXI_TRIG1_STR', 'PXI_Trig1', 'The trigger is received on PXI trigger line 1.' ], [ - 'NIRFSG_VAL_PXI_TRIG2_STR', 'PXI_Trig2', 'The trigger is received on PXI trigger line 2.' ], [ - 'NIRFSG_VAL_PXI_TRIG3_STR', 'PXI_Trig3', 'The trigger is received on PXI trigger line 3.' ], [ - 'NIRFSG_VAL_PXI_TRIG4_STR', 'PXI_Trig4', 'The trigger is received on PXI trigger line 4.' ], [ - 'NIRFSG_VAL_PXI_TRIG5_STR', 'PXI_Trig5', 'The trigger is received on PXI trigger line 5.' ], [ - 'NIRFSG_VAL_PXI_TRIG6_STR', 'PXI_Trig6', 'The trigger is received on PXI trigger line 6.' ], [ - 'NIRFSG_VAL_PXIE_DSTARC_STR', 'PXIe_DStarC', 'The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSG_VAL_DIO0_STR', 'DIO/PFI0', 'The trigger is received on PFI0 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO1_STR', 'DIO/PFI1', 'The trigger is received on PFI1 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO2_STR', 'DIO/PFI2', 'The trigger is received on PFI2 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO3_STR', 'DIO/PFI3', 'The trigger is received on PFI3 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO4_STR', 'DIO/PFI4', 'The trigger is received on PFI4 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO5_STR', 'DIO/PFI5', 'The trigger is received on PFI5 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO6_STR', 'DIO/PFI6', 'The trigger is received on PFI6 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO7_STR', 'DIO/PFI7', 'The trigger is received on PFI7 from the front panel DIO terminal.' ] ], 'table_header': [ - 'Name', - 'Value', + 'Possible Value', 'Description' ] }, - 'enum': 'ScriptTrigExportOutputTerm', 'lv_property': 'Triggers:Script:Export Output Terminal', 'name': 'EXPORTED_SCRIPT_TRIGGER_OUTPUT_TERMINAL', 'supported_rep_caps': [ @@ -1392,26 +1284,22 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the Sample Clock source for the device. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: NIRFSG_VAL_ONBOARD_CLOCK_STR is the only supported value for this device.\n\n **Default Value:** NIRFSG_VAL_ONBOARD_CLOCK_STR\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Timing Configurations `_\n \n **Defined Values**:\n ', + 'description': ' Specifies the Sample Clock source for the device. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: NIRFSG_VAL_ONBOARD_CLOCK_STR is the only supported value for this device.\n\n **Default Value:** NIRFSG_VAL_ONBOARD_CLOCK_STR\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Timing Configurations `_\n \n **Possible Values**:\n ', 'table_body': [ [ - 'NIRFSG_VAL_CLK_IN_STR', 'ClkIn', 'Uses the external clock as the Sample Clock source.' ], [ - 'NIRFSG_VAL_ONBOARD_CLOCK_STR', 'OnboardClock', 'Uses the AWG module onboard clock as the Sample Clock source.' ] ], 'table_header': [ - 'Name', - 'Value', + 'Possible Value', 'Description' ] }, - 'enum': 'ArbSampleClockSource', 'lv_property': 'Clock:Arb Sample Clock Source', 'name': 'ARB_SAMPLE_CLOCK_SOURCE', 'type': 'ViString' @@ -1773,7 +1661,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the destination terminal for exporting the Reference Clock on the RF signal generators. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** NIRFSG_VAL_DO_NOT_EXPORT_STR\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Interconnecting Multiple NI 5673E Modules `_\n \n **Defined Values**:\n\nName (Value): Description\n\nNIRFSG_VAL_DO_NOT_EXPORT_STR () :The Reference Clock signal is not exported.\n\nNIRFSG_VAL_REF_OUT_STR (RefOut) :Exports the Reference Clock signal to the REF OUT connector of the device.\n\nNIRFSG_VAL_REF_OUT2_STR (RefOut2) :Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable.\n\nNIRFSG_VAL_CLK_OUT_STR (ClkOut) :Exports the Reference Clock signal to the CLK OUT connector of the device.\n ', + 'description': ' Specifies the destination terminal for exporting the Reference Clock on the RF signal generators. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Possible Values**:\n\nPossible Value: Description\n\n"" :The Reference Clock signal is not exported.\n\nRefOut :Exports the Reference Clock signal to the REF OUT connector of the device.\n\nRefOut2 :Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable.\n\nClkOut :Exports the Reference Clock signal to the CLK OUT connector of the device.\n\n **Default Value:** NIRFSG_VAL_DO_NOT_EXPORT_STR\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Interconnecting Multiple NI 5673E Modules `_\n ', 'note': 'The NIRFSG_VAL_REF_OUT2_STR output terminal value is valid for only the PXIe-5650/5651/5652, not the PXI-5650/5651/5652.', 'table_body': [ [ @@ -1784,7 +1672,7 @@ ], [ 'NIRFSG_VAL_DO_NOT_EXPORT_STR', - '', + 'empty', 'The Reference Clock signal is not exported.', 'Supported on PXIe-5644/5645/5646, 5820/5830/5831/5832/5840/5841/5842/5860, 5650/5651/5652, 5654, 5673, 5673E, PXIe-5654 with PXIe-5696, PXI-5650/5651/5652 (See Note)' ], @@ -1808,7 +1696,6 @@ 'Supported devices' ] }, - 'enum': 'ReferenceClockExportOutputTerminal', 'lv_property': 'Clock:Reference Clock Export Output Terminal', 'name': 'EXPORTED_REF_CLOCK_OUTPUT_TERMINAL', 'type': 'ViString' @@ -1817,131 +1704,106 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the source terminal for the Script Trigger. This attribute is used when the NIRFSG_ATTR_SCRIPT_TRIGGER_TYPE attribute is set to NIRFSG_VAL_DIGITAL_LEVEL. The NIRFSG_ATTR_DIGITAL_LEVEL_SCRIPT_TRIGGER_SOURCE attribute is not case-sensitive.\n\n To set the NIRFSG_ATTR_DIGITAL_LEVEL_SCRIPT_TRIGGER_SOURCE attribute, the NI-RFSG device must be in the Configuration state.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Script Trigger `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n \n **Defined Values**:\n ', + 'description': ' Specifies the source terminal for the Script Trigger. This attribute is used when the NIRFSG_ATTR_SCRIPT_TRIGGER_TYPE attribute is set to NIRFSG_VAL_DIGITAL_LEVEL. The NIRFSG_ATTR_DIGITAL_LEVEL_SCRIPT_TRIGGER_SOURCE attribute is not case-sensitive.\n\n To set the NIRFSG_ATTR_DIGITAL_LEVEL_SCRIPT_TRIGGER_SOURCE attribute, the NI-RFSG device must be in the Configuration state.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Script Trigger `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n \n **Possible Values**:\n ', 'table_body': [ [ - 'NIRFSG_VAL_PFI0_STR', 'PFI0', 'The trigger is received on PFI 0.' ], [ - 'NIRFSG_VAL_PFI1_STR', 'PFI1', 'The trigger is received on PFI 1.' ], [ - 'NIRFSG_VAL_PFI2_STR', 'PFI2', 'The trigger is received on PFI 2.' ], [ - 'NIRFSG_VAL_PFI3_STR', 'PFI3', 'The trigger is received on PFI 3.' ], [ - 'NIRFSG_VAL_PXI_STAR_STR', 'PXI_Star', 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' ], [ - 'NIRFSG_VAL_PXI_TRIG0_STR', 'PXI_Trig0', 'The trigger is received on PXI trigger line 0.' ], [ - 'NIRFSG_VAL_PXI_TRIG1_STR', 'PXI_Trig1', 'The trigger is received on PXI trigger line 1.' ], [ - 'NIRFSG_VAL_PXI_TRIG2_STR', 'PXI_Trig2', 'The trigger is received on PXI trigger line 2.' ], [ - 'NIRFSG_VAL_PXI_TRIG3_STR', 'PXI_Trig3', 'The trigger is received on PXI trigger line 3.' ], [ - 'NIRFSG_VAL_PXI_TRIG4_STR', 'PXI_Trig4', 'The trigger is received on PXI trigger line 4.' ], [ - 'NIRFSG_VAL_PXI_TRIG5_STR', 'PXI_Trig5', 'The trigger is received on PXI trigger line 5.' ], [ - 'NIRFSG_VAL_PXI_TRIG6_STR', 'PXI_Trig6', 'The trigger is received on PXI trigger line 6.' ], [ - 'NIRFSG_VAL_PXI_TRIG7_STR', 'PXI_Trig7', 'The trigger is received on PXI trigger line 7.' ], [ - 'NIRFSG_VAL_PXIE_DSTARB_STR', 'PXIe_DStarB', 'The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860.' ], [ - 'NIRFSG_VAL_PULSE_IN_STR', 'PulseIn', 'The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842.' ], [ - 'NIRFSG_VAL_DIO0_STR', 'DIO/PFI0', 'The trigger is received on PFI0 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO1_STR', 'DIO/PFI1', 'The trigger is received on PFI1 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO2_STR', 'DIO/PFI2', 'The trigger is received on PFI2 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO3_STR', 'DIO/PFI3', 'The trigger is received on PFI3 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO4_STR', 'DIO/PFI4', 'The trigger is received on PFI4 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO5_STR', 'DIO/PFI5', 'The trigger is received on PFI5 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO6_STR', 'DIO/PFI6', 'The trigger is received on PFI6 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO7_STR', 'DIO/PFI7', 'The trigger is received on PFI7 from the front panel DIO terminal.' ] ], 'table_header': [ - 'Name', - 'Value', + 'Possible Value', 'Description' ] }, - 'enum': 'ScriptTrigDigLevelSource', 'lv_property': 'Triggers:Script:Digital Level:Source', 'name': 'DIGITAL_LEVEL_SCRIPT_TRIGGER_SOURCE', 'supported_rep_caps': [ @@ -2058,121 +1920,98 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the destination terminal for exporting the Done event. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Triggers `_\n\n `Events `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n \n **High-Level Functions**:\n\n - nirfsg_ExportSignal\n \n **Defined Values**:\n ', + 'description': ' Specifies the destination terminal for exporting the Done event. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Triggers `_\n\n `Events `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n \n **High-Level Functions**:\n\n - nirfsg_ExportSignal\n \n **Possible Values**:\n ', 'table_body': [ [ - 'NIRFSG_VAL_DO_NOT_EXPORT_STR', - '', + 'empty', 'The signal is not exported.' ], [ - 'NIRFSG_VAL_PFI0_STR', 'PFI0', 'The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0.' ], [ - 'NIRFSG_VAL_PFI1_STR', 'PFI1', 'The signal is exported to the PFI 1 connector.' ], [ - 'NIRFSG_VAL_PFI4_STR', 'PFI4', 'The signal is exported to the PFI 4 connector.' ], [ - 'NIRFSG_VAL_PFI5_STR', 'PFI5', 'The signal is exported to the PFI 5 connector.' ], [ - 'NIRFSG_VAL_PXI_TRIG0_STR', 'PXI_Trig0', 'The trigger is received on PXI trigger line 0.' ], [ - 'NIRFSG_VAL_PXI_TRIG1_STR', 'PXI_Trig1', 'The trigger is received on PXI trigger line 1.' ], [ - 'NIRFSG_VAL_PXI_TRIG2_STR', 'PXI_Trig2', 'The trigger is received on PXI trigger line 2.' ], [ - 'NIRFSG_VAL_PXI_TRIG3_STR', 'PXI_Trig3', 'The trigger is received on PXI trigger line 3.' ], [ - 'NIRFSG_VAL_PXI_TRIG4_STR', 'PXI_Trig4', 'The trigger is received on PXI trigger line 4.' ], [ - 'NIRFSG_VAL_PXI_TRIG5_STR', 'PXI_Trig5', 'The trigger is received on PXI trigger line 5.' ], [ - 'NIRFSG_VAL_PXI_TRIG6_STR', 'PXI_Trig6', 'The trigger is received on PXI trigger line 6.' ], [ - 'NIRFSG_VAL_PXIE_DSTARC_STR', 'PXIe_DStarC', 'The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSG_VAL_DIO0_STR', 'DIO/PFI0', 'The trigger is received on PFI0 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO1_STR', 'DIO/PFI1', 'The trigger is received on PFI1 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO2_STR', 'DIO/PFI2', 'The trigger is received on PFI2 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO3_STR', 'DIO/PFI3', 'The trigger is received on PFI3 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO4_STR', 'DIO/PFI4', 'The trigger is received on PFI4 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO5_STR', 'DIO/PFI5', 'The trigger is received on PFI5 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO6_STR', 'DIO/PFI6', 'The trigger is received on PFI6 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO7_STR', 'DIO/PFI7', 'The trigger is received on PFI7 from the front panel DIO terminal.' ] ], 'table_header': [ - 'Name', - 'Value', + 'Posible Value', 'Description' ] }, - 'enum': 'DoneEventExportOutputTerm', 'lv_property': 'Events:Done Event Export Output Terminal', 'name': 'EXPORTED_DONE_EVENT_OUTPUT_TERMINAL', 'type': 'ViString' @@ -2181,121 +2020,98 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the destination terminal for exporting the Marker Event. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Marker Events `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n \n **High-Level Functions**:\n\n - nirfsg_ExportSignal\n \n **Defined Values**:\n ', + 'description': ' Specifies the destination terminal for exporting the Marker Event. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Marker Events `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n \n **High-Level Functions**:\n\n - nirfsg_ExportSignal\n \n **Possible Values**:\n ', 'table_body': [ [ - 'NIRFSG_VAL_DO_NOT_EXPORT_STR', - '', + 'empty', 'The signal is not exported.' ], [ - 'NIRFSG_VAL_PFI0_STR', 'PFI0', 'The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0.' ], [ - 'NIRFSG_VAL_PFI1_STR', 'PFI1', 'The signal is exported to the PFI 1 connector.' ], [ - 'NIRFSG_VAL_PFI4_STR', 'PFI4', 'The signal is exported to the PFI 4 connector.' ], [ - 'NIRFSG_VAL_PFI5_STR', 'PFI5', 'The signal is exported to the PFI 5 connector.' ], [ - 'NIRFSG_VAL_PXI_TRIG0_STR', 'PXI_Trig0', 'The trigger is received on PXI trigger line 0.' ], [ - 'NIRFSG_VAL_PXI_TRIG1_STR', 'PXI_Trig1', 'The trigger is received on PXI trigger line 1.' ], [ - 'NIRFSG_VAL_PXI_TRIG2_STR', 'PXI_Trig2', 'The trigger is received on PXI trigger line 2.' ], [ - 'NIRFSG_VAL_PXI_TRIG3_STR', 'PXI_Trig3', 'The trigger is received on PXI trigger line 3.' ], [ - 'NIRFSG_VAL_PXI_TRIG4_STR', 'PXI_Trig4', 'The trigger is received on PXI trigger line 4.' ], [ - 'NIRFSG_VAL_PXI_TRIG5_STR', 'PXI_Trig5', 'The trigger is received on PXI trigger line 5.' ], [ - 'NIRFSG_VAL_PXI_TRIG6_STR', 'PXI_Trig6', 'The trigger is received on PXI trigger line 6.' ], [ - 'NIRFSG_VAL_PXIE_DSTARC_STR', 'PXIe_DStarC', 'The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSG_VAL_DIO0_STR', 'DIO/PFI0', 'The trigger is received on PFI0 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO1_STR', 'DIO/PFI1', 'The trigger is received on PFI1 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO2_STR', 'DIO/PFI2', 'The trigger is received on PFI2 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO3_STR', 'DIO/PFI3', 'The trigger is received on PFI3 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO4_STR', 'DIO/PFI4', 'The trigger is received on PFI4 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO5_STR', 'DIO/PFI5', 'The trigger is received on PFI5 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO6_STR', 'DIO/PFI6', 'The trigger is received on PFI6 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO7_STR', 'DIO/PFI7', 'The trigger is received on PFI7 from the front panel DIO terminal.' ] ], 'table_header': [ - 'Name', - 'Value', + 'Possible Value', 'Description' ] }, - 'enum': 'MarkerEventExportOutputTerm', 'lv_property': 'Events:Marker:Output Terminal', 'name': 'EXPORTED_MARKER_EVENT_OUTPUT_TERMINAL', 'repeated_capability_type': 'markers', @@ -2308,121 +2124,98 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the destination terminal for exporting the Started event. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Events `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n \n **High-Level Functions**:\n\n - nirfsg_ExportSignal\n \n **Defined Values**:\n ', + 'description': ' Specifies the destination terminal for exporting the Started event. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Events `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n \n **High-Level Functions**:\n\n - nirfsg_ExportSignal\n \n **Possible Values**:\n ', 'table_body': [ [ - 'NIRFSG_VAL_DO_NOT_EXPORT_STR', - '', + 'empty', 'The signal is not exported.' ], [ - 'NIRFSG_VAL_PFI0_STR', 'PFI0', 'The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0.' ], [ - 'NIRFSG_VAL_PFI1_STR', 'PFI1', 'The signal is exported to the PFI 1 connector.' ], [ - 'NIRFSG_VAL_PFI4_STR', 'PFI4', 'The signal is exported to the PFI 4 connector.' ], [ - 'NIRFSG_VAL_PFI5_STR', 'PFI5', 'The signal is exported to the PFI 5 connector.' ], [ - 'NIRFSG_VAL_PXI_TRIG0_STR', 'PXI_Trig0', 'The trigger is received on PXI trigger line 0.' ], [ - 'NIRFSG_VAL_PXI_TRIG1_STR', 'PXI_Trig1', 'The trigger is received on PXI trigger line 1.' ], [ - 'NIRFSG_VAL_PXI_TRIG2_STR', 'PXI_Trig2', 'The trigger is received on PXI trigger line 2.' ], [ - 'NIRFSG_VAL_PXI_TRIG3_STR', 'PXI_Trig3', 'The trigger is received on PXI trigger line 3.' ], [ - 'NIRFSG_VAL_PXI_TRIG4_STR', 'PXI_Trig4', 'The trigger is received on PXI trigger line 4.' ], [ - 'NIRFSG_VAL_PXI_TRIG5_STR', 'PXI_Trig5', 'The trigger is received on PXI trigger line 5.' ], [ - 'NIRFSG_VAL_PXI_TRIG6_STR', 'PXI_Trig6', 'The trigger is received on PXI trigger line 6.' ], [ - 'NIRFSG_VAL_PXIE_DSTARC_STR', 'PXIe_DStarC', 'The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860.' ], [ - 'NIRFSG_VAL_DIO0_STR', 'DIO/PFI0', 'The trigger is received on PFI0 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO1_STR', 'DIO/PFI1', 'The trigger is received on PFI1 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO2_STR', 'DIO/PFI2', 'The trigger is received on PFI2 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO3_STR', 'DIO/PFI3', 'The trigger is received on PFI3 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO4_STR', 'DIO/PFI4', 'The trigger is received on PFI4 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO5_STR', 'DIO/PFI5', 'The trigger is received on PFI5 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO6_STR', 'DIO/PFI6', 'The trigger is received on PFI6 from the front panel DIO terminal.' ], [ - 'NIRFSG_VAL_DIO7_STR', 'DIO/PFI7', 'The trigger is received on PFI7 from the front panel DIO terminal.' ] ], 'table_header': [ - 'Name', - 'Value', + 'Possible Value', 'Description' ] }, - 'enum': 'StartedEventExportOutputTerm', 'lv_property': 'Events:Started Event Export Output Terminal', 'name': 'EXPORTED_STARTED_EVENT_OUTPUT_TERMINAL', 'type': 'ViString' @@ -2869,66 +2662,54 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the destination terminal for exporting the Configuration Settled event. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Supported Devices:** PXIe-5654/5654 with PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Triggers `_\n\n `Events `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n\n **Defined Values**:\n ', + 'description': ' Specifies the destination terminal for exporting the Configuration Settled event. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Supported Devices:** PXIe-5654/5654 with PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Triggers `_\n\n `Events `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n\n **Possible Values**:\n ', 'table_body': [ [ - 'NIRFSG_VAL_DO_NOT_EXPORT_STR', - '', + 'empty', 'The signal is not exported.' ], [ - 'NIRFSG_VAL_PXI_TRIG0_STR', 'PXI_Trig0', 'The trigger is received on PXI trigger line 0.' ], [ - 'NIRFSG_VAL_PXI_TRIG1_STR', 'PXI_Trig1', 'The trigger is received on PXI trigger line 1.' ], [ - 'NIRFSG_VAL_PXI_TRIG2_STR', 'PXI_Trig2', 'The trigger is received on PXI trigger line 2.' ], [ - 'NIRFSG_VAL_PXI_TRIG3_STR', 'PXI_Trig3', 'The trigger is received on PXI trigger line 3.' ], [ - 'NIRFSG_VAL_PXI_TRIG4_STR', 'PXI_Trig4', 'The trigger is received on PXI trigger line 4.' ], [ - 'NIRFSG_VAL_PXI_TRIG5_STR', 'PXI_Trig5', 'The trigger is received on PXI trigger line 5.' ], [ - 'NIRFSG_VAL_PXI_TRIG6_STR', 'PXI_Trig6', 'The trigger is received on PXI trigger line 6.' ], [ - 'NIRFSG_VAL_PXIE_DSTARC_STR', 'PXIe_DStarC', 'The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5840/5841/5842.' ], [ - 'NIRFSG_VAL_TRIG_OUT_STR', 'TrigOut', 'TRIG IN/OUT terminal.' ] ], 'table_header': [ - 'Name', - 'Value', + 'Possible Value', 'Description' ] }, - 'enum': 'ConfigurationSettledEventExportOutputTerm', 'lv_property': 'Events:Configuration Settled Event Export Output Terminal', 'name': 'EXPORTED_CONFIGURATION_SETTLED_EVENT_OUTPUT_TERMINAL', 'type': 'ViString' @@ -3199,42 +2980,35 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies whether to use the internal or external local oscillator (LO) source. If the NIRFSG_ATTR_LO_SOURCE attribute is set to "" (empty string), NI-RFSG uses the internal LO source. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n To use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsg_SetAttributeViString function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string).\n\n **Default Value:** NIRFSG_VAL_LO_SOURCE_ONBOARD_STR\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `PXIe-5830 LO Sharing Using NI-RFSA and NI-RFSG `_\n\n `PXIe-5831/5832 LO Sharing Using NI-RFSA and NI-RFSG `_\n \n **Defined Values**:\n ', + 'description': ' Specifies whether to use the internal or external local oscillator (LO) source. If the NIRFSG_ATTR_LO_SOURCE attribute is set to "" (empty string), NI-RFSG uses the internal LO source. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n To use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsg_SetAttributeViString function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string).\n\n **Default Value:** NIRFSG_VAL_LO_SOURCE_ONBOARD_STR\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `PXIe-5830 LO Sharing Using NI-RFSA and NI-RFSG `_\n\n `PXIe-5831/5832 LO Sharing Using NI-RFSA and NI-RFSG `_\n \n **Possible Values**:\n ', 'note': 'For the PXIe-5841 with PXIe-5655, RF list mode is not supported when this attribute is set to NIRFSG_VAL_LO_SOURCE_SG_SA_SHARED_STR.', 'table_body': [ [ - 'NIRFSG_VAL_LO_SOURCE_AUTOMATIC_SG_SA_SHARED_STR', 'Automatic_SG_SA_Shared', 'NI-RFSG internally makes the configuration to share the LO between NI-RFSA and NI-RFSG. This value is valid only on the PXIe-5820/5830/5831/5832/5840/5841/5842.' ], [ - 'NIRFSG_VAL_LO_SOURCE_LO_IN_STR', 'LO_In', 'Uses an external LO as the LO source. Connect a signal to the LO IN connector on the device and use the NIRFSG_ATTR_UPCONVERTER_CENTER_FREQUENCY attribute to specify the LO frequency.' ], [ - 'NIRFSG_VAL_LO_SOURCE_ONBOARD_STR', 'Onboard', 'Uses an internal LO as the LO source. If you specify an internal LO source, the LO is generated inside the device itself.' ], [ - 'NIRFSG_VAL_LO_SOURCE_SG_SA_SHARED_STR', 'SG_SA_Shared', 'Uses the same internal LO during NI-RFSA and NI-RFSG sessions. NI-RFSG selects an internal synthesizer and the synthesizer signal is switched to both the RF In and RF Out mixers. This value is valid only on the PXIe-5830/5831/5832/5841 with PXIe-5655/5842.' ], [ - 'NIRFSG_VAL_LO_SOURCE_SECONDARY_STR', 'Secondary', 'Uses the PXIe-5831/5840 internal LO as the LO source. This value is valid only on the PXIe-5831 with PXIe-5653 and PXIe-5832 with PXIe-5653.' ] ], 'table_header': [ - 'Name', - 'Value', + 'Possible Value', 'Description' ] }, - 'enum': 'LoSource', 'lv_property': 'Device Specific:Vector Signal Transceiver:Signal Path:LO Source', 'name': 'LO_SOURCE', 'type': 'ViString' @@ -4475,11 +4249,11 @@ 'description': ' Specifies the configurations to skip while loading from a file.\n\n **Default Value:** NIRFSG_VAL_SKIP_NONE\n \n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n \n **Defined Values**:\n ', 'table_body': [ [ - 'NIRFSG_VAL_SKIP_NONE', + 'RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_LOAD_OPTIONS_SKIP_NONE', 'NI-RFSG loads all the configurations to the session.' ], [ - 'NIRFSG_VAL_SKIP_WAVEFORM', + 'RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_LOAD_OPTIONS_SKIP_WAVEFORMS', 'NI-RFSG skips loading the waveform configurations to the session.' ] ], @@ -4500,19 +4274,19 @@ 'description': ' Specifies the configurations to skip to reset while loading configurations from a file.\n\n **Default Value:** NIRFSG_VAL_SKIP_NONE\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n \n **Defined Values**:\n ', 'table_body': [ [ - 'NIRFSG_VAL_SKIP_NONE', + 'RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_NONE', 'NI-RFSG resets all configurations.' ], [ - 'NIRFSG_VAL_SKIP_WAVEFORMS', + 'RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_WAVEFORMS', 'NI-RFSG skips resetting the waveform configurations.' ], [ - 'NIRFSG_VAL_SKIP_SCRIPTS', + 'RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_SCRIPTS', 'NI-RFSG skips resetting the scripts.' ], [ - 'NIRFSG_VAL_SKIP_DEEMBEDDING_TABLES', + 'RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_DEEMBEDDING_TABLES', 'NI-RFSG skips resetting the de-embedding tables.' ] ], @@ -4630,41 +4404,34 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the source of the pulse modulation signal. When Pulse In in used, the pulse modulation is applied with the lowest latency and jitter, but is not aligned to any particular waveform sample. When a marker is used, the RF pulse is aligned to a specific sample in the arbitrary waveform. To set this property, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** NIRFSG_VAL_PULSE_IN_STR\n\n **Supported Devices:** PXIe-5842\n \n **Defined Values**:\n ', + 'description': ' Specifies the source of the pulse modulation signal. When Pulse In in used, the pulse modulation is applied with the lowest latency and jitter, but is not aligned to any particular waveform sample. When a marker is used, the RF pulse is aligned to a specific sample in the arbitrary waveform. To set this property, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** NIRFSG_VAL_PULSE_IN_STR\n\n **Supported Devices:** PXIe-5842\n \n **Possible Values**:\n ', 'table_body': [ [ - 'NIRFSG_VAL_PULSE_IN_STR', 'PulseIn', 'The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842.' ], [ - 'NIRFSG_VAL_MARKER0_STR', - '', + 'Marker0', 'The trigger is received from the Marker 0.' ], [ - 'NIRFSG_VAL_MARKER1_STR', - '', + 'Marker1', 'The trigger is received from the Marker 1.' ], [ - 'NIRFSG_VAL_MARKER2_STR', - '', + 'Marker2', 'The trigger is received from the Marker 2.' ], [ - 'NIRFSG_VAL_MARKER3_STR', - '', + 'Marker3', 'The trigger is received from the Marker 3.' ] ], 'table_header': [ - 'Name', - 'Value', + 'Possible Value', 'Description' ] }, - 'enum': 'PulseModulationSource', 'lv_property': 'Modulation:Pulse:Pulse Modulation Source', 'name': 'PULSE_MODULATION_SOURCE', 'type': 'ViString' @@ -4673,26 +4440,22 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the destination terminal for exporting the Pulse Modulation Event. The Pulse Modulation Event tracks the RF Envelope when Pulse Modulation is Enabled. If this property is set to a value other than `do not export str`, calling NI-RFSG Commit will cause the output terminal to be pulled to the logic level that is the inverse of `exported pulse modulation event active level`. You can tri-state this terminal by setting this property to `do not export str` or by calling `niRFSG Reset`. To set this property, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** NIRFSG_VAL_PULSE_OUT_STR\n\n **Supported Devices:** PXIe-5842\n \n **Defined Values**:\n ', + 'description': ' Specifies the destination terminal for exporting the Pulse Modulation Event. The Pulse Modulation Event tracks the RF Envelope when Pulse Modulation is Enabled. If this property is set to a value other than `do not export str`, calling NI-RFSG Commit will cause the output terminal to be pulled to the logic level that is the inverse of `exported pulse modulation event active level`. You can tri-state this terminal by setting this property to `do not export str` or by calling `niRFSG Reset`. To set this property, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** NIRFSG_VAL_PULSE_OUT_STR\n\n **Supported Devices:** PXIe-5842\n \n **Possible Values**:\n ', 'table_body': [ [ - 'NIRFSG_VAL_DO_NOT_EXPORT_STR', '', 'Pulse modulation video signal is not exported.' ], [ - 'NIRFSG_VAL_PULSE_OUT_STR', 'PulseOut', 'Export the pulse modulation video signal on the pulse out terminal.' ] ], 'table_header': [ - 'Name', - 'Value', + 'Possible Value', 'Description' ] }, - 'enum': 'PulseModulationOutputTerm', 'lv_property': 'Events:Pulse Modulation:Exported Pulse Modulation Event Output Terminal', 'name': 'EXPORTED_PULSE_MODULATION_EVENT_OUTPUT_TERMINAL', 'type': 'ViString' diff --git a/src/nirfsg/metadata/enums.py b/src/nirfsg/metadata/enums.py index d8c8fc549..99484673f 100644 --- a/src/nirfsg/metadata/enums.py +++ b/src/nirfsg/metadata/enums.py @@ -256,25 +256,6 @@ } ] }, - 'ArbSampleClockSource': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'Uses the AWG module onboard clock as the Sample Clock source.' - }, - 'name': 'NIRFSG_VAL_ONBOARD_CLOCK_STR', - 'value': 'OnboardClock' - }, - { - 'documentation': { - 'description': 'Uses the external clock as the Sample Clock source.' - }, - 'name': 'NIRFSG_VAL_CLK_IN_STR', - 'value': 'ClkIn' - } - ] - }, 'AutomaticLevelControl': { 'codegen_method': 'public', 'values': [ @@ -356,338 +337,6 @@ } ] }, - 'ConfigListTrigDigEdgeSource': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'The trigger is received on PFI 0.' - }, - 'name': 'NIRFSG_VAL_PFI0_STR', - 'value': 'PFI0' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI 1.' - }, - 'name': 'NIRFSG_VAL_PFI1_STR', - 'value': 'PFI1' - }, - { - 'documentation': { - 'description': 'The trigger is received on PXI trigger line 0.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG0_STR', - 'value': 'PXI_Trig0' - }, - { - 'documentation': { - 'description': 'The trigger is received on PXI trigger line 1.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG1_STR', - 'value': 'PXI_Trig1' - }, - { - 'documentation': { - 'description': 'The trigger is received on PXI trigger line 2.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG2_STR', - 'value': 'PXI_Trig2' - }, - { - 'documentation': { - 'description': 'The trigger is received on PXI trigger line 3.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG3_STR', - 'value': 'PXI_Trig3' - }, - { - 'documentation': { - 'description': 'The trigger is received on PXI trigger line 4.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG4_STR', - 'value': 'PXI_Trig4' - }, - { - 'documentation': { - 'description': 'The trigger is received on PXI trigger line 5.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG5_STR', - 'value': 'PXI_Trig5' - }, - { - 'documentation': { - 'description': 'The trigger is received on PXI trigger line 6.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG6_STR', - 'value': 'PXI_Trig6' - }, - { - 'documentation': { - 'description': 'The trigger is received on PXI trigger line 7.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG7_STR', - 'value': 'PXI_Trig7' - }, - { - 'documentation': { - 'description': 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' - }, - 'name': 'NIRFSG_VAL_PXI_STAR_STR', - 'value': 'PXI_Star' - }, - { - 'documentation': { - 'description': 'The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5840/5841/5842.' - }, - 'name': 'NIRFSG_VAL_PXIE_DSTARB_STR', - 'value': 'PXIe_DStarB' - }, - { - 'documentation': { - 'description': 'The trigger is received from the Marker Event 0.' - }, - 'name': 'NIRFSG_VAL_MARKER0_EVENT_STR', - 'value': 'Marker0Event' - }, - { - 'documentation': { - 'description': 'The trigger is received from the Marker Event 1.' - }, - 'name': 'NIRFSG_VAL_MARKER1_EVENT_STR', - 'value': 'Marker1Event' - }, - { - 'documentation': { - 'description': 'The trigger is received from the Marker Event 2.' - }, - 'name': 'NIRFSG_VAL_MARKER2_EVENT_STR', - 'value': 'Marker2Event' - }, - { - 'documentation': { - 'description': 'The trigger is received from the Marker Event 3.' - }, - 'name': 'NIRFSG_VAL_MARKER3_EVENT_STR', - 'value': 'Marker3Event' - }, - { - 'documentation': { - 'description': 'The trigger is received from the Timer Event.' - }, - 'name': 'NIRFSG_VAL_TIMER_EVENT_STR', - 'value': 'TimerEvent' - }, - { - 'documentation': { - 'description': 'The trigger is received on the TRIG IN/OUT terminal. This value is valid on only the PXIe-5654/5654 with PXIe-5696.' - }, - 'name': 'NIRFSG_VAL_TRIG_IN_STR', - 'value': 'TrigIn' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI0 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO0_STR', - 'value': 'DIO/PFI0' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI1 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO1_STR', - 'value': 'DIO/PFI1' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI2 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO2_STR', - 'value': 'DIO/PFI2' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI3 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO3_STR', - 'value': 'DIO/PFI3' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI4 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO4_STR', - 'value': 'DIO/PFI4' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI5 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO5_STR', - 'value': 'DIO/PFI5' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI6 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO6_STR', - 'value': 'DIO/PFI6' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI7 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO7_STR', - 'value': 'DIO/PFI7' - } - ] - }, - 'ConfigListTrigExportOutputTerm': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'The signal is not exported.' - }, - 'name': 'NIRFSG_VAL_DO_NOT_EXPORT_STR', - 'value': '' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0. ' - }, - 'name': 'NIRFSG_VAL_PFI0_STR', - 'value': 'PFI0' - }, - { - 'documentation': { - 'description': 'The signal is exported on PFI 1 connector.' - }, - 'name': 'NIRFSG_VAL_PFI1_STR', - 'value': 'PFI1' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 0. .' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG0_STR', - 'value': 'PXI_Trig0' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 0. ' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG1_STR', - 'value': 'PXI_Trig1' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 2.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG2_STR', - 'value': 'PXI_Trig2' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 3.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG3_STR', - 'value': 'PXI_Trig3' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 4.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG4_STR', - 'value': 'PXI_Trig4' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 5.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG5_STR', - 'value': 'PXI_Trig5' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 6.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG6_STR', - 'value': 'PXI_Trig6' - }, - { - 'documentation': { - 'description': 'The trigger is received on the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5840/5841/5842.' - }, - 'name': 'NIRFSG_VAL_PXIE_DSTARC_STR', - 'value': 'PXIe_DStarC' - }, - { - 'documentation': { - 'description': 'The trigger is received on the TRIG IN/OUT terminal. This value is valid on only the PXIe-5654/5654 with PXIe-5696.' - }, - 'name': 'NIRFSG_VAL_TRIG_OUT_STR', - 'value': 'TrigOut' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI0 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO0_STR', - 'value': 'DIO/PFI0' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI1 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO1_STR', - 'value': 'DIO/PFI1' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI2 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO2_STR', - 'value': 'DIO/PFI2' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI3 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO3_STR', - 'value': 'DIO/PFI3' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI4 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO4_STR', - 'value': 'DIO/PFI4' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI5 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO5_STR', - 'value': 'DIO/PFI5' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI6 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO6_STR', - 'value': 'DIO/PFI6' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI7 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO7_STR', - 'value': 'DIO/PFI7' - } - ] - }, 'ConfigListTrigType': { 'codegen_method': 'public', 'values': [ @@ -700,7 +349,7 @@ }, { 'documentation': { - 'description': 'Data operation does not start until a digital edge is detected. The source of the digital edge is specified in the %attribute{digital edge configuration list step trigger source} attribute, and the active edge is always rising.' + 'description': 'Data operation does not start until a digital edge is detected. The source of the digital edge is specified in the NIRFSG_ATTR_DIGITAL_EDGE_CONFIGURATION_LIST_STEP_TRIGGER_SOURCE attribute, and the active edge is always rising.' }, 'name': 'NIRFSG_VAL_DIGITAL_EDGE', 'value': 1 @@ -734,81 +383,6 @@ } ] }, - 'ConfigurationSettledEventExportOutputTerm': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'The signal is not exported.' - }, - 'name': 'NIRFSG_VAL_DO_NOT_EXPORT_STR', - 'value': '' - }, - { - 'documentation': { - 'description': 'PXI trigger line 0.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG0_STR', - 'value': 'PXI_Trig0' - }, - { - 'documentation': { - 'description': 'PXI trigger line 1.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG1_STR', - 'value': 'PXI_Trig1' - }, - { - 'documentation': { - 'description': 'PXI trigger line 2.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG2_STR', - 'value': 'PXI_Trig2' - }, - { - 'documentation': { - 'description': 'PXI trigger line 3.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG3_STR', - 'value': 'PXI_Trig3' - }, - { - 'documentation': { - 'description': 'PXI trigger line 4.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG4_STR', - 'value': 'PXI_Trig4' - }, - { - 'documentation': { - 'description': 'PXI trigger line 5.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG5_STR', - 'value': 'PXI_Trig5' - }, - { - 'documentation': { - 'description': 'PXI trigger line 6.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG6_STR', - 'value': 'PXI_Trig6' - }, - { - 'documentation': { - 'description': 'PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842.' - }, - 'name': 'NIRFSG_VAL_PXIE_DSTARC_STR', - 'value': 'PXIe_DStarC' - }, - { - 'documentation': { - 'description': 'TRIG IN/OUT terminal.' - }, - 'name': 'NIRFSG_VAL_TRIG_OUT_STR', - 'value': 'TrigOut' - } - ] - }, 'DacDecoderMode': { 'values': [ { @@ -843,10 +417,6 @@ 'name': 'NIRFSG_VAL_DEEMBEDDING_TYPE_NONE', 'value': 25000 }, - { - 'name': 'NIRFSG_VAL_NONE', - 'value': 0 - }, { 'documentation': { 'description': 'De-embeds the measurement using only the gain term.' @@ -908,7 +478,7 @@ }, { 'documentation': { - 'description': 'Specifies that the digital modulation waveform type is user defined. To specify the user-defined waveform, call the %function{configure digital modulation user defined waveform} function.' + '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 @@ -960,178 +530,26 @@ } ] }, - 'DoneEventExportOutputTerm': { + 'FilterType': { 'codegen_method': 'public', 'values': [ { 'documentation': { - 'description': 'The signal is not exported.' + 'description': 'No filter type is applied.' }, - 'name': 'NIRFSG_VAL_DO_NOT_EXPORT_STR', - 'value': '' + 'name': 'NIRFSG_VAL_NONE', + 'value': 0 }, { 'documentation': { - 'description': 'The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0.' - }, - 'name': 'NIRFSG_VAL_PFI0_STR', - 'value': 'PFI0' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PFI 1 connector.' - }, - 'name': 'NIRFSG_VAL_PFI1_STR', - 'value': 'PFI1' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PFI 4 connector.' - }, - 'name': 'NIRFSG_VAL_PFI4_STR', - 'value': 'PFI4' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PFI 5 connector.' - }, - 'name': 'NIRFSG_VAL_PFI5_STR', - 'value': 'PFI5' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 0.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG0_STR', - 'value': 'PXI_Trig0' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 1.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG1_STR', - 'value': 'PXI_Trig1' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 2.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG2_STR', - 'value': 'PXI_Trig2' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 3.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG3_STR', - 'value': 'PXI_Trig3' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 4.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG4_STR', - 'value': 'PXI_Trig4' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 5.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG5_STR', - 'value': 'PXI_Trig5' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 6.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG6_STR', - 'value': 'PXI_Trig6' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' - }, - 'name': 'NIRFSG_VAL_PXIE_DSTARC_STR', - 'value': 'PXIe_DStarC' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI0 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO0_STR', - 'value': 'DIO/PFI0' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI1 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO1_STR', - 'value': 'DIO/PFI1' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI2 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO2_STR', - 'value': 'DIO/PFI2' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI3 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO3_STR', - 'value': 'DIO/PFI3' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI4 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO4_STR', - 'value': 'DIO/PFI4' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI5 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO5_STR', - 'value': 'DIO/PFI5' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI6 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO6_STR', - 'value': 'DIO/PFI6' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI7 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO7_STR', - 'value': 'DIO/PFI7' - } - ] - }, - 'FilterType': { - 'codegen_method': 'public', - '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 %attribute{arb filter root raised cosine alpha} attribute.' + '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 %attribute{arb filter raised cosine alpha} attribute.' + '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 @@ -1226,14 +644,14 @@ }, { 'documentation': { - 'description': 'Configures the RF signal generator to generate the arbitrary waveform specified by the %attribute{arb selected waveform} attribute.' + 'description': 'Configures the RF signal generator to generate the arbitrary waveform specified by the NIRFSG_ATTR_ARB_SELECTED_WAVEFORM attribute.' }, 'name': 'NIRFSG_VAL_ARB_WAVEFORM', 'value': 1001 }, { 'documentation': { - 'description': 'Configures the RF signal generator to generate arbitrary waveforms as directed by the %attribute{selected script} attribute.' + 'description': 'Configures the RF signal generator to generate arbitrary waveforms as directed by the NIRFSG_ATTR_SELECTED_SCRIPT attribute.' }, 'name': 'NIRFSG_VAL_SCRIPT', 'value': 1002 @@ -1383,46 +801,6 @@ } ] }, - 'LoSource': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'Uses an internal LO as the LO source. If you specify an internal LO source, the LO is generated inside the device itself.' - }, - 'name': 'NIRFSG_VAL_LO_SOURCE_ONBOARD_STR', - 'value': 'Onboard' - }, - { - 'documentation': { - 'description': 'Uses an external LO as the LO source. Connect a signal to the LO IN connector on the device and use the %attribute{upconverter center frequency} attribute to specify the LO frequency.' - }, - 'name': 'NIRFSG_VAL_LO_SOURCE_LO_IN_STR', - 'value': 'LO_In' - }, - { - 'documentation': { - 'description': 'Uses the PXIe-5831/5840 internal LO as the LO source. This value is valid only on the PXIe-5831 with PXIe-5653 and PXIe-5832 with PXIe-5653.' - }, - 'name': 'NIRFSG_VAL_LO_SOURCE_SECONDARY_STR', - 'value': 'Secondary' - }, - { - 'documentation': { - 'description': 'Uses the same internal LO during NI-RFSA and NI-RFSG sessions. NI-RFSG selects an internal synthesizer and the synthesizer signal is switched to both the RF In and RF Out mixers. This value is valid only on the PXIe-5830/5831/5832/5841 with PXIe-5655/5842.' - }, - 'name': 'NIRFSG_VAL_LO_SOURCE_SG_SA_SHARED_STR', - 'value': 'SG_SA_Shared' - }, - { - 'documentation': { - 'description': 'NI-RFSG internally makes the configuration to share the LO between NI-RFSA and NI-RFSG. This value is valid only on the PXIe-5820/5830/5831/5832/5840/5841/5842.' - }, - 'name': 'NIRFSG_VAL_LO_SOURCE_AUTOMATIC_SG_SA_SHARED_STR', - 'value': 'Automatic_SG_SA_Shared' - } - ] - }, 'LoadOptions': { 'codegen_method': 'public', 'values': [ @@ -1433,19 +811,11 @@ 'name': 'RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_LOAD_OPTIONS_SKIP_NONE', 'value': 0 }, - { - 'name': 'NIRFSG_VAL_MANUAL', - 'value': 0 - }, { 'documentation': { 'description': 'NI-RFSG skips loading the waveform configurations to the session.' }, - 'name': 'RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_LOAD_OPTIONS_SKIP_WAVEFORM', - 'value': 1 - }, - { - 'name': 'NIRFSG_VAL_SCRIPT_TRIGGER', + 'name': 'RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_LOAD_OPTIONS_SKIP_WAVEFORMS', 'value': 1 } ] @@ -1476,158 +846,6 @@ } ] }, - 'MarkerEventExportOutputTerm': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'The signal is not exported.' - }, - 'name': 'NIRFSG_VAL_DO_NOT_EXPORT_STR', - 'value': '' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0.' - }, - 'name': 'NIRFSG_VAL_PFI0_STR', - 'value': 'PFI0' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PFI 1 connector.' - }, - 'name': 'NIRFSG_VAL_PFI1_STR', - 'value': 'PFI1' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PFI 4 connector.' - }, - 'name': 'NIRFSG_VAL_PFI4_STR', - 'value': 'PFI4' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PFI 5 connector.' - }, - 'name': 'NIRFSG_VAL_PFI5_STR', - 'value': 'PFI5' - }, - { - 'documentation': { - 'description': 'The signal is exported to PXI trigger line 0.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG0_STR', - 'value': 'PXI_Trig0' - }, - { - 'documentation': { - 'description': 'The signal is exported to PXI trigger line 1.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG1_STR', - 'value': 'PXI_Trig1' - }, - { - 'documentation': { - 'description': 'The signal is exported to PXI trigger line 2.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG2_STR', - 'value': 'PXI_Trig2' - }, - { - 'documentation': { - 'description': 'The signal is exported to PXI trigger line 3.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG3_STR', - 'value': 'PXI_Trig3' - }, - { - 'documentation': { - 'description': 'The signal is exported to PXI trigger line 4.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG4_STR', - 'value': 'PXI_Trig4' - }, - { - 'documentation': { - 'description': 'The signal is exported to PXI trigger line 5.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG5_STR', - 'value': 'PXI_Trig5' - }, - { - 'documentation': { - 'description': 'The signal is exported to PXI trigger line 6.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG6_STR', - 'value': 'PXI_Trig6' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' - }, - 'name': 'NIRFSG_VAL_PXIE_DSTARC_STR', - 'value': 'PXIe_DStarC' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI0 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO0_STR', - 'value': 'DIO/PFI0' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI1 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO1_STR', - 'value': 'DIO/PFI1' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI2 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO2_STR', - 'value': 'DIO/PFI2' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI3 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO3_STR', - 'value': 'DIO/PFI3' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI4 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO4_STR', - 'value': 'DIO/PFI4' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI5 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO5_STR', - 'value': 'DIO/PFI5' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI6 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO6_STR', - 'value': 'DIO/PFI6' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI7 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO7_STR', - 'value': 'DIO/PFI7' - } - ] - }, 'MarkerEventOutputBehavior': { 'codegen_method': 'public', 'values': [ @@ -1863,7 +1081,7 @@ }, { 'documentation': { - 'description': 'Indicates the maximum power level of the RF signal averaged over one period of the RF carrier frequency (the peak envelope power). This setting requires that the magnitude of the I/Q waveform must always be less than or equal to one. When using peak power, the power level of the RF signal matches the specified power level at moments when the magnitude of the I/Q waveform equals one. If you write more than one waveform, the relative scaling between waveforms is preserved. In peak power mode, waveforms are scaled according to the %attribute{arb waveform software scaling factor} attribute. You can use the %attribute{peak power adjustment} attribute in conjunction with the %attribute{power level} attribute when the %attribute{power level type} attribute is set to %enum_value{power level type.peak power}.' + 'description': 'Indicates the maximum power level of the RF signal averaged over one period of the RF carrier frequency (the peak envelope power). This setting requires that the magnitude of the I/Q waveform must always be less than or equal to one. When using peak power, the power level of the RF signal matches the specified power level at moments when the magnitude of the I/Q waveform equals one. If you write more than one waveform, the relative scaling between waveforms is preserved. In peak power mode, waveforms are scaled according to the NIRFSG_ATTR_ARB_WAVEFORM_SOFTWARE_SCALING_FACTOR attribute. You can use the NIRFSG_ATTR_PEAK_POWER_ADJUSTMENT attribute in conjunction with the NIRFSG_ATTR_POWER_LEVEL attribute when the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute is set to NIRFSG_VAL_PEAK_POWER.' }, 'name': 'NIRFSG_VAL_PEAK_POWER', 'value': 7001 @@ -1929,171 +1147,82 @@ } ] }, - 'PulseModulationOutputTerm': { + 'RFBlanking': { 'codegen_method': 'public', 'values': [ { 'documentation': { - 'description': 'Pulse modulation video signal is not exported.' + 'description': 'RF blanking is disabled.' }, - 'name': 'NIRFSG_VAL_DO_NOT_EXPORT_STR', - 'value': '' + 'name': 'NIRFSG_VAL_DISABLE', + 'value': 0 }, { 'documentation': { - 'description': 'Export the pulse modulation video signal on the pulse out terminal.' + 'description': 'RF blanking is enabled.' }, - 'name': 'NIRFSG_VAL_PULSE_OUT_STR', - 'value': 'PulseOut' + 'name': 'NIRFSG_VAL_ENABLE', + 'value': 1 } ] }, - 'PulseModulationSource': { + 'RFFilter': { 'codegen_method': 'public', 'values': [ { 'documentation': { - 'description': 'The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842.' - }, - 'name': 'NIRFSG_VAL_PULSE_IN_STR', - 'value': 'PulseIn' - }, - { - 'documentation': { - 'description': 'The trigger is received from the Marker 0.' + 'description': 'yet to be defined' }, - 'name': 'NIRFSG_VAL_MARKER0_STR', - 'value': 'Marker0' + 'name': 'NIRFSG_VAL_HI_FREQ_MOD', + 'value': '0' }, { - 'documentation': { - 'description': 'The trigger is received from the Marker 1.' - }, - 'name': 'NIRFSG_VAL_MARKER1_STR', - 'value': 'Marker1' + 'name': 'NIRFSG_VAL_CONFIGURATION_SETTLED_EVENT', + 'value': 7 }, { 'documentation': { - 'description': 'The trigger is received from the Marker 2.' + 'description': 'yet to be defined' }, - 'name': 'NIRFSG_VAL_MARKER2_STR', - 'value': 'Marker2' + 'name': 'NIRFSG_VAL_LO_FREQ_MOD_4000', + 'value': '1' }, { 'documentation': { - 'description': 'The trigger is received from the Marker 3.' + 'description': 'yet to be defined' }, - 'name': 'NIRFSG_VAL_MARKER3_STR', - 'value': 'Marker3' + 'name': 'NIRFSG_VAL_LO_FREQ_MOD_2500', + 'value': '2' } ] }, - 'PxiChassisClk10Source': { + 'RFInLoExportEnabled': { 'codegen_method': 'public', 'values': [ { 'documentation': { - 'description': 'Do not drive the PXI_CLK10 signal.' + 'description': 'The RF IN local oscillator signal may or may not be present at the front panel LO OUT connector, because NI-RFSA may' + }, + 'name': 'NIRFSG_VAL_UNSPECIFIED', + 'value': -2 + }, + { + 'documentation': { + 'description': 'The RF In local oscillator signal is not present at the front panel LO OUT connector.' }, - 'name': 'NIRFSG_VAL_NONE', + 'name': 'NIRFSG_VAL_DISABLE', 'value': 0 }, { - 'name': 'NIRFSG_VAL_DO_NOT_EXPORT_STR', - 'value': '' + 'name': 'NIRFSG_VAL_MANUAL', + 'value': 0 }, { 'documentation': { - 'description': 'Uses the highly stable oven-controlled onboard Reference Clock to drive the PXI_CLK signal.' + 'description': 'The RF In local oscillator signal is present at the front panel LO OUT connector.' }, - 'name': 'NIRFSG_VAL_ONBOARD_CLOCK_STR', - 'value': 'OnboardClock' - }, - { - 'documentation': { - 'description': 'Uses the clock present at the front panel REF IN connector to drive the PXI_CLK signal.' - }, - 'name': 'NIRFSG_VAL_REF_IN_STR', - 'value': 'RefIn' - } - ] - }, - 'RFBlanking': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'RF blanking is disabled.' - }, - 'name': 'NIRFSG_VAL_DISABLE', - 'value': 0 - }, - { - 'documentation': { - 'description': 'RF blanking is enabled.' - }, - 'name': 'NIRFSG_VAL_ENABLE', - 'value': 1 - } - ] - }, - 'RFFilter': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'yet to be defined' - }, - 'name': 'NIRFSG_VAL_HI_FREQ_MOD', - 'value': '0' - }, - { - 'name': 'NIRFSG_VAL_CONFIGURATION_SETTLED_EVENT', - 'value': 7 - }, - { - 'documentation': { - 'description': 'yet to be defined' - }, - 'name': 'NIRFSG_VAL_LO_FREQ_MOD_4000', - 'value': '1' - }, - { - 'documentation': { - 'description': 'yet to be defined' - }, - 'name': 'NIRFSG_VAL_LO_FREQ_MOD_2500', - 'value': '2' - } - ] - }, - 'RFInLoExportEnabled': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'The RF IN local oscillator signal may or may not be present at the front panel LO OUT connector, because NI-RFSA may' - }, - 'name': 'NIRFSG_VAL_UNSPECIFIED', - 'value': -2 - }, - { - 'documentation': { - 'description': 'The RF In local oscillator signal is not present at the front panel LO OUT connector.' - }, - 'name': 'NIRFSG_VAL_DISABLE', - 'value': 0 - }, - { - 'name': 'NIRFSG_VAL_MANUAL', - 'value': 0 - }, - { - 'documentation': { - 'description': 'The RF In local oscillator signal is present at the front panel LO OUT connector.' - }, - 'name': 'NIRFSG_VAL_ENABLE', - 'value': 1 + 'name': 'NIRFSG_VAL_ENABLE', + 'value': 1 }, { 'name': 'NIRFSG_VAL_SCRIPT_TRIGGER', @@ -2125,39 +1254,6 @@ } ] }, - 'ReferenceClockExportOutputTerminal': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'The Reference Clock signal is not exported.' - }, - 'name': 'NIRFSG_VAL_DO_NOT_EXPORT_STR', - 'value': '' - }, - { - 'documentation': { - 'description': 'Exports the Reference Clock signal to the REF OUT connector of the device.' - }, - 'name': 'NIRFSG_VAL_REF_OUT_STR', - 'value': 'RefOut' - }, - { - 'documentation': { - 'description': 'Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable.' - }, - 'name': 'NIRFSG_VAL_REF_OUT2_STR', - 'value': 'RefOut2' - }, - { - 'documentation': { - 'description': 'Exports the Reference Clock signal to the CLK OUT connector of the device.' - }, - 'name': 'NIRFSG_VAL_CLK_OUT_STR', - 'value': 'ClkOut' - } - ] - }, 'ReferenceClockExportedRate': { 'codegen_method': 'public', 'values': [ @@ -2207,53 +1303,6 @@ } ] }, - 'ReferenceClockSource': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'Uses the onboard Reference Clock as the clock source.' - }, - 'name': 'NIRFSG_VAL_ONBOARD_CLOCK_STR', - 'value': 'OnboardClock' - }, - { - 'documentation': { - 'description': 'Uses the clock signal present at the front panel REF IN connector as the Reference Clock source.' - }, - 'name': 'NIRFSG_VAL_REF_IN_STR', - 'value': 'RefIn' - }, - { - 'documentation': { - 'description': 'Uses the PXI_CLK signal, which is present on the PXI backplane, as the Reference Clock source.' - }, - 'name': 'NIRFSG_VAL_PXI_CLK_STR', - 'value': 'PXI_CLK' - }, - { - 'documentation': { - 'description': 'Uses the clock signal present at the front panel CLK IN connector as the Reference Clock source. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5831 with PXIe-5653/5832/5832 with PXIe-5653/5840/5841/5841 with PXIe-5655.' - }, - 'name': 'NIRFSG_VAL_CLK_IN_STR', - 'value': 'ClkIn' - }, - { - 'documentation': { - 'description': 'This value is not valid on any supported devices.' - }, - 'name': 'NIRFSG_VAL_REF_IN_2_STR', - 'value': 'RefIn2' - }, - { - 'documentation': { - 'description': 'This value is valid on only the PXIe-5831/5832 with PXIe-5653. **PXIe-5831/5832 with PXIe-5653 —** NI-RFSG configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3622 to use NIRFSG_VAL_PXI_CLK_STR %enum_value as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector.' - }, - 'name': 'NIRFSG_VAL_PXI_CLK_MASTER_STR', - 'value': 'PXI_ClkMaster' - } - ] - }, 'RelativeTo': { 'codegen_method': 'public', 'values': [ @@ -2381,1292 +1430,256 @@ } ] }, - 'ScriptTrigDigEdgeSource': { + 'ScriptTrigDigLevelActiveLevel': { 'codegen_method': 'public', 'values': [ { 'documentation': { - 'description': 'The trigger is received on PFI 0.' + 'description': 'Trigger when the digital trigger signal is high.' }, - 'name': 'NIRFSG_VAL_PFI0_STR', - 'value': 'PFI0' + 'name': 'NIRFSG_VAL_ACTIVE_HIGH', + 'value': 9000 }, { 'documentation': { - 'description': 'The trigger is received on PFI 1.' + 'description': 'Trigger when the digital trigger signal is low.' }, - 'name': 'NIRFSG_VAL_PFI1_STR', - 'value': 'PFI1' - }, + 'name': 'NIRFSG_VAL_ACTIVE_LOW', + 'value': 9001 + } + ] + }, + 'ScriptTrigType': { + 'codegen_method': 'public', + 'values': [ { 'documentation': { - 'description': 'The trigger is received on PFI 2.' + 'description': 'No trigger is configured. Signal generation starts immediately.' }, - 'name': 'NIRFSG_VAL_PFI2_STR', - 'value': 'PFI2' + 'name': 'NIRFSG_VAL_NONE', + 'value': 0 }, { 'documentation': { - 'description': 'The trigger is received on PFI 3.' + 'description': 'The data operation does not start until a digital edge is detected. The source of the digital edge is specified with the NIRFSG_ATTR_DIGITAL_EDGE_START_TRIGGER_SOURCE attribute, and the active edge is specified with the NIRFSG_ATTR_DIGITAL_EDGE_START_TRIGGER_EDGE attribute.' }, - 'name': 'NIRFSG_VAL_PFI3_STR', - 'value': 'PFI3' + 'name': 'NIRFSG_VAL_DIGITAL_EDGE', + 'value': 1 }, { 'documentation': { - 'description': 'The trigger is received on PXI trigger line 0.' + 'description': 'The data operation does not start until the digital level is detected. The source of the digital level is specified in the NIRFSG_ATTR_DIGITAL_LEVEL_SCRIPT_TRIGGER_SOURCE attribute, and the active level is specified in the NIRFSG_ATTR_DIGITAL_LEVEL_SCRIPT_TRIGGER_ACTIVE_LEVEL attribute.' }, - 'name': 'NIRFSG_VAL_PXI_TRIG0_STR', - 'value': 'PXI_Trig0' + 'name': 'NIRFSG_VAL_DIGITAL_LEVEL', + 'value': 8000 }, { 'documentation': { - 'description': 'The trigger is received on PXI trigger line 1.' + 'description': 'The data operation does not start until a software trigger occurs. You can create a software event by calling the nirfsg_SendSoftwareEdgeTrigger function.' }, - 'name': 'NIRFSG_VAL_PXI_TRIG1_STR', - 'value': 'PXI_Trig1' - }, + 'name': 'NIRFSG_VAL_SOFTWARE', + 'value': 2 + } + ] + }, + 'SelfCalibrateRangeStepsToOmit': { + 'codegen_method': 'public', + 'values': [ { 'documentation': { - 'description': 'The trigger is received on PXI trigger line 2.' + 'description': 'Omits the Image Suppression step. If you omit this step, the Residual Sideband Image performance is not adjusted.' }, - 'name': 'NIRFSG_VAL_PXI_TRIG2_STR', - 'value': 'PXI_Trig2' + 'name': 'NIRFSG_VAL_SELF_CAL_IMAGE_SUPPRESSION', + 'value': 8 }, { 'documentation': { - 'description': 'The trigger is received on PXI trigger line 3.' + 'description': 'Omits the LO Self Cal step. If you omit this step, the power level of the LO is not adjusted.' }, - 'name': 'NIRFSG_VAL_PXI_TRIG3_STR', - 'value': 'PXI_Trig3' + 'name': 'NIRFSG_VAL_SELF_CAL_LO_SELF_CAL', + 'value': 1 }, { 'documentation': { - 'description': 'The trigger is received on PXI trigger line 4.' + 'description': 'No calibration steps are omitted.' }, - 'name': 'NIRFSG_VAL_PXI_TRIG4_STR', - 'value': 'PXI_Trig4' + 'name': 'NIRFSG_VAL_SELF_CAL_OMIT_NONE', + 'value': 0 }, { 'documentation': { - 'description': 'The trigger is received on PXI trigger line 5.' + 'description': 'Omits the Power Level Accuracy step. If you omit this step, the power level accuracy of the device is not adjusted.' }, - 'name': 'NIRFSG_VAL_PXI_TRIG5_STR', - 'value': 'PXI_Trig5' + 'name': 'NIRFSG_VAL_SELF_CAL_POWER_LEVEL_ACCURACY', + 'value': 2 }, { 'documentation': { - 'description': 'The trigger is received on PXI trigger line 6.' + 'description': 'Omits the Residual LO Power step. If you omit this step, the Residual LO Power performance is not adjusted.' }, - 'name': 'NIRFSG_VAL_PXI_TRIG6_STR', - 'value': 'PXI_Trig6' + 'name': 'NIRFSG_VAL_SELF_CAL_RESIDUAL_LO_POWER', + 'value': 4 }, { 'documentation': { - 'description': 'The trigger is received on PXI trigger line 7.' + 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' }, - 'name': 'NIRFSG_VAL_PXI_TRIG7_STR', - 'value': 'PXI_Trig7' - }, + 'name': 'NIRFSG_VAL_SELF_CAL_SYNTHESIZER_ALIGNMENT', + 'value': 16 + } + ] + }, + 'Signal': { + 'codegen_method': 'public', + 'values': [ { 'documentation': { - 'description': 'The trigger is received on the PXI star trigger line. This value is not valid on the PXIe-5644/5645/5646.' + 'description': 'Exports a Configuration Settled Event.' }, - 'name': 'NIRFSG_VAL_PXI_STAR_STR', - 'value': 'PXI_Star' + 'name': 'NIRFSG_VAL_CONFIGURATION_SETTLED_EVENT', + 'value': 7 }, { 'documentation': { - 'description': 'The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/' + 'description': 'Exports a Start Trigger.' }, - 'name': 'NIRFSG_VAL_PXIE_DSTARB_STR', - 'value': 'PXIe_DStarB' + 'name': 'NIRFSG_VAL_START_TRIGGER', + 'value': 0 }, { 'documentation': { - 'description': 'The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842.' + 'description': 'Exports a Script Trigger.' }, - 'name': 'NIRFSG_VAL_PULSE_IN_STR', - 'value': 'PulseIn' + 'name': 'NIRFSG_VAL_SCRIPT_TRIGGER', + 'value': 1 }, { 'documentation': { - 'description': 'The trigger is received on PFI0 from the front panel DIO terminal.' + 'description': 'Exports a Marker Event.' }, - 'name': 'NIRFSG_VAL_DIO0_STR', - 'value': 'DIO/PFI0' + 'name': 'NIRFSG_VAL_MARKER_EVENT', + 'value': 2 }, { 'documentation': { - 'description': 'The trigger is received on PFI1 from the front panel DIO terminal.' + 'description': 'Exports the Reference Clock.' }, - 'name': 'NIRFSG_VAL_DIO1_STR', - 'value': 'DIO/PFI1' + 'name': 'NIRFSG_VAL_REF_CLOCK', + 'value': 3 }, { 'documentation': { - 'description': 'The trigger is received on PFI2 from the front panel DIO terminal.' + 'description': 'Exports a Started Event.' }, - 'name': 'NIRFSG_VAL_DIO2_STR', - 'value': 'DIO/PFI2' + 'name': 'NIRFSG_VAL_STARTED_EVENT', + 'value': 4 }, { 'documentation': { - 'description': 'The trigger is received on PFI3 from the front panel DIO terminal.' + 'description': 'Exports a Done Event.' }, - 'name': 'NIRFSG_VAL_DIO3_STR', - 'value': 'DIO/PFI3' + 'name': 'NIRFSG_VAL_DONE_EVENT', + 'value': 5 }, { 'documentation': { - 'description': 'The trigger is received on PFI4 from the front panel DIO terminal.' + 'description': 'Exports a Configuration List Step Trigger.' }, - 'name': 'NIRFSG_VAL_DIO4_STR', - 'value': 'DIO/PFI4' - }, + 'name': 'NIRFSG_VAL_CONFIGURATION_LIST_STEP_TRIGGER', + 'value': 6 + } + ] + }, + 'SoftwareTriggerType': { + 'codegen_method': 'public', + 'values': [ { 'documentation': { - 'description': 'The trigger is received on PFI5 from the front panel DIO terminal.' + 'description': 'Specifies the Script Trigger.' }, - 'name': 'NIRFSG_VAL_DIO5_STR', - 'value': 'DIO/PFI5' + 'name': 'NIRFSG_VAL_SCRIPT_TRIGGER', + 'value': 1 }, { 'documentation': { - 'description': 'The trigger is received on PFI6 from the front panel DIO terminal.' + 'description': 'Specifies the Start Trigger.' }, - 'name': 'NIRFSG_VAL_DIO6_STR', - 'value': 'DIO/PFI6' - }, + 'name': 'NIRFSG_VAL_START_TRIGGER', + 'value': 0 + } + ] + }, + 'SparameterOrientation': { + 'codegen_method': 'public', + 'values': [ { 'documentation': { - 'description': 'The trigger is received on PFI7 from the front panel DIO terminal.' + 'description': 'Port 1 of the S2P is oriented towards the DUT port.' }, - 'name': 'NIRFSG_VAL_DIO7_STR', - 'value': 'DIO/PFI7' + 'name': 'NIRFSG_VAL_PORT1_TOWARDS_DUT', + 'value': 24000 }, { 'documentation': { - 'description': 'The trigger is received on the Sync Script trigger line. This value is valid on only the PXIe-5644/5645/5646.' + 'description': 'Port 2 of the S2P is oriented towards the DUT port.' }, - 'name': 'NIRFSG_VAL_SYNC_SCRIPT_TRIGGER_STR', - 'value': 'Sync_Script' + 'name': 'NIRFSG_VAL_PORT2_TOWARDS_DUT', + 'value': 24001 } ] }, - 'ScriptTrigDigLevelActiveLevel': { + 'StartTrigDigEdgeEdge': { 'codegen_method': 'public', 'values': [ { 'documentation': { - 'description': 'Trigger when the digital trigger signal is high.' + 'description': 'Occurs when the signal transitions from low level to high level.' }, - 'name': 'NIRFSG_VAL_ACTIVE_HIGH', - 'value': 9000 + 'name': 'NIRFSG_VAL_RISING_EDGE', + 'value': 0 }, { 'documentation': { - 'description': 'Trigger when the digital trigger signal is low.' + 'description': 'Occurs when the signal transitions from high level to low level.' }, - 'name': 'NIRFSG_VAL_ACTIVE_LOW', - 'value': 9001 + 'name': 'NIRFSG_VAL_FALLING_EDGE', + 'value': 1 } ] }, - 'ScriptTrigDigLevelSource': { + 'StartTrigType': { 'codegen_method': 'public', 'values': [ { 'documentation': { - 'description': 'The trigger is received on PFI 0.' + 'description': 'No trigger is configured.' }, - 'name': 'NIRFSG_VAL_PFI0_STR', - 'value': 'PFI0' + 'name': 'NIRFSG_VAL_NONE', + 'value': 0 }, { 'documentation': { - 'description': 'The trigger is received on PFI 1.' + 'description': 'The data operation does not start until a digital edge is detected. The source of the digital edge is specified with the NIRFSG_ATTR_DIGITAL_EDGE_START_TRIGGER_SOURCE attribute, and the active edge is specified in the NIRFSG_ATTR_DIGITAL_EDGE_START_TRIGGER_EDGE attribute.' }, - 'name': 'NIRFSG_VAL_PFI1_STR', - 'value': 'PFI1' + 'name': 'NIRFSG_VAL_DIGITAL_EDGE', + 'value': 1 }, { 'documentation': { - 'description': 'The trigger is received on PFI 2.' + 'description': 'The data operation does not start until a software event occurs. You may create a software trigger by calling the nirfsg_SendSoftwareEdgeTrigger function.' }, - 'name': 'NIRFSG_VAL_PFI2_STR', - 'value': 'PFI2' + 'name': 'NIRFSG_VAL_SOFTWARE', + 'value': 2 }, { 'documentation': { - 'description': 'The trigger is received on PFI 3.' - }, - 'name': 'NIRFSG_VAL_PFI3_STR', - 'value': 'PFI3' - }, - { - 'documentation': { - 'description': 'The trigger is received on PXI trigger line 0.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG0_STR', - 'value': 'PXI_Trig0' - }, - { - 'documentation': { - 'description': 'The trigger is received on PXI trigger line 1.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG1_STR', - 'value': 'PXI_Trig1' - }, - { - 'documentation': { - 'description': 'The trigger is received on PXI trigger line 2.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG2_STR', - 'value': 'PXI_Trig2' - }, - { - 'documentation': { - 'description': 'The trigger is received on PXI trigger line 3.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG3_STR', - 'value': 'PXI_Trig3' - }, - { - 'documentation': { - 'description': 'The trigger is received on PXI trigger line 4.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG4_STR', - 'value': 'PXI_Trig4' - }, - { - 'documentation': { - 'description': 'The trigger is received on PXI trigger line 5.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG5_STR', - 'value': 'PXI_Trig5' - }, - { - 'documentation': { - 'description': 'The trigger is received on PXI trigger line 6.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG6_STR', - 'value': 'PXI_Trig6' - }, - { - 'documentation': { - 'description': 'The trigger is received on PXI trigger line 7.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG7_STR', - 'value': 'PXI_Trig7' - }, - { - 'documentation': { - 'description': 'The trigger is received on the PXI star trigger line. This value is not valid on the PXIe-5644/5645/5646.' - }, - 'name': 'NIRFSG_VAL_PXI_STAR_STR', - 'value': 'PXI_Star' - }, - { - 'documentation': { - 'description': 'The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/' - }, - 'name': 'NIRFSG_VAL_PXIE_DSTARB_STR', - 'value': 'PXIe_DStarB' - }, - { - 'documentation': { - 'description': 'The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842.' - }, - 'name': 'NIRFSG_VAL_PULSE_IN_STR', - 'value': 'PulseIn' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI0 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO0_STR', - 'value': 'DIO/PFI0' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI1 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO1_STR', - 'value': 'DIO/PFI1' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI2 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO2_STR', - 'value': 'DIO/PFI2' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI3 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO3_STR', - 'value': 'DIO/PFI3' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI4 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO4_STR', - 'value': 'DIO/PFI4' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI5 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO5_STR', - 'value': 'DIO/PFI5' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI6 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO6_STR', - 'value': 'DIO/PFI6' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI7 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO7_STR', - 'value': 'DIO/PFI7' - } - ] - }, - 'ScriptTrigExportOutputTerm': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'The signal is not exported.' - }, - 'name': 'NIRFSG_VAL_DO_NOT_EXPORT_STR', - 'value': '' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0.' - }, - 'name': 'NIRFSG_VAL_PFI0_STR', - 'value': 'PFI0' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PFI 1 connector.' - }, - 'name': 'NIRFSG_VAL_PFI1_STR', - 'value': 'PFI1' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PFI 4 connector.' - }, - 'name': 'NIRFSG_VAL_PFI4_STR', - 'value': 'PFI4' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PFI 5 connector.' - }, - 'name': 'NIRFSG_VAL_PFI5_STR', - 'value': 'PFI5' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 0.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG0_STR', - 'value': 'PXI_Trig0' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 1.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG1_STR', - 'value': 'PXI_Trig1' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 2.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG2_STR', - 'value': 'PXI_Trig2' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 3.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG3_STR', - 'value': 'PXI_Trig3' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 4.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG4_STR', - 'value': 'PXI_Trig4' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 5.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG5_STR', - 'value': 'PXI_Trig5' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 6.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG6_STR', - 'value': 'PXI_Trig6' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/' - }, - 'name': 'NIRFSG_VAL_PXIE_DSTARC_STR', - 'value': 'PXIe_DStarC' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI0 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO0_STR', - 'value': 'DIO/PFI0' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI1 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO1_STR', - 'value': 'DIO/PFI1' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI2 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO2_STR', - 'value': 'DIO/PFI2' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI3 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO3_STR', - 'value': 'DIO/PFI3' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI4 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO4_STR', - 'value': 'DIO/PFI4' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI5 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO5_STR', - 'value': 'DIO/PFI5' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI6 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO6_STR', - 'value': 'DIO/PFI6' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI7 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO7_STR', - 'value': 'DIO/PFI7' - } - ] - }, - 'ScriptTrigType': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'No trigger is configured. Signal generation starts immediately.' - }, - 'name': 'NIRFSG_VAL_NONE', - 'value': 0 - }, - { - 'documentation': { - 'description': 'The data operation does not start until a digital edge is detected. The source of the digital edge is specified with the %attribute{digital edge start trigger source} attribute, and the active edge is specified with the %attribute{digital edge start trigger edge} attribute.' - }, - 'name': 'NIRFSG_VAL_DIGITAL_EDGE', - 'value': 1 - }, - { - 'documentation': { - 'description': 'The data operation does not start until the digital level is detected. The source of the digital level is specified in the %attribute{digital level script trigger source} attribute, and the active level is specified in the %attribute{digital level script trigger active level} attribute.' - }, - 'name': 'NIRFSG_VAL_DIGITAL_LEVEL', - 'value': 8000 - }, - { - 'documentation': { - 'description': 'The data operation does not start until a software trigger occurs. You can create a software event by calling the %function{send software edge trigger} function.' - }, - 'name': 'NIRFSG_VAL_SOFTWARE', - 'value': 2 - } - ] - }, - 'SelfCalibrateRangeStepsToOmit': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'Omits the Image Suppression step. If you omit this step, the Residual Sideband Image performance is not adjusted.' - }, - 'name': 'NIRFSG_VAL_SELF_CAL_IMAGE_SUPPRESSION', - 'value': 8 - }, - { - 'documentation': { - 'description': 'Omits the LO Self Cal step. If you omit this step, the power level of the LO is not adjusted.' - }, - 'name': 'NIRFSG_VAL_SELF_CAL_LO_SELF_CAL', - 'value': 1 - }, - { - 'documentation': { - 'description': 'No calibration steps are omitted.' - }, - 'name': 'NIRFSG_VAL_SELF_CAL_OMIT_NONE', - 'value': 0 - }, - { - 'documentation': { - 'description': 'Omits the Power Level Accuracy step. If you omit this step, the power level accuracy of the device is not adjusted.' - }, - 'name': 'NIRFSG_VAL_SELF_CAL_POWER_LEVEL_ACCURACY', - 'value': 2 - }, - { - 'documentation': { - 'description': 'Omits the Residual LO Power step. If you omit this step, the Residual LO Power performance is not adjusted.' - }, - 'name': 'NIRFSG_VAL_SELF_CAL_RESIDUAL_LO_POWER', - 'value': 4 - }, - { - 'documentation': { - 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' - }, - 'name': 'NIRFSG_VAL_SELF_CAL_SYNTHESIZER_ALIGNMENT', - 'value': 16 - } - ] - }, - 'Signal': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'Exports a Configuration Settled Event.' - }, - 'name': 'NIRFSG_VAL_CONFIGURATION_SETTLED_EVENT', - 'value': 7 - }, - { - 'documentation': { - 'description': 'Exports a Start Trigger.' - }, - 'name': 'NIRFSG_VAL_START_TRIGGER', - 'value': 0 - }, - { - 'documentation': { - 'description': 'Exports a Script Trigger.' - }, - 'name': 'NIRFSG_VAL_SCRIPT_TRIGGER', - 'value': 1 - }, - { - 'documentation': { - 'description': 'Exports a Marker Event.' - }, - 'name': 'NIRFSG_VAL_MARKER_EVENT', - 'value': 2 - }, - { - 'documentation': { - 'description': 'Exports the Reference Clock.' - }, - 'name': 'NIRFSG_VAL_REF_CLOCK', - 'value': 3 - }, - { - 'documentation': { - 'description': 'Exports a Started Event.' - }, - 'name': 'NIRFSG_VAL_STARTED_EVENT', - 'value': 4 - }, - { - 'documentation': { - 'description': 'Exports a Done Event.' - }, - 'name': 'NIRFSG_VAL_DONE_EVENT', - 'value': 5 - }, - { - 'documentation': { - 'description': 'Exports a Configuration List Step Trigger.' - }, - 'name': 'NIRFSG_VAL_CONFIGURATION_LIST_STEP_TRIGGER', - 'value': 6 - } - ] - }, - 'SignalIdentifier': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'Specifies Marker 0.' - }, - 'name': 'NIRFSG_VAL_MARKER_EVENT0', - 'value': 'marker0' - }, - { - 'documentation': { - 'description': 'Specifies Marker 1.' - }, - 'name': 'NIRFSG_VAL_MARKER_EVENT1', - 'value': 'marker1' - }, - { - 'documentation': { - 'description': 'Specifies Marker 2.' - }, - 'name': 'NIRFSG_VAL_MARKER_EVENT2', - 'value': 'marker2' - }, - { - 'documentation': { - 'description': 'Specifies Marker 3.' - }, - 'name': 'NIRFSG_VAL_MARKER_EVENT3', - 'value': 'marker3' - }, - { - 'documentation': { - 'description': 'Specifies Script Trigger 0.' - }, - 'name': 'NIRFSG_VAL_SCRIPT_TRIGGER0', - 'value': 'scriptTrigger0' - }, - { - 'documentation': { - 'description': 'Specifies Script Trigger 1.' - }, - 'name': 'NIRFSG_VAL_SCRIPT_TRIGGER1', - 'value': 'scriptTrigger1' - }, - { - 'documentation': { - 'description': 'Specifies Script Trigger 2.' - }, - 'name': 'NIRFSG_VAL_SCRIPT_TRIGGER2', - 'value': 'scriptTrigger2' - }, - { - 'documentation': { - 'description': 'Specifies Script Trigger 3.' - }, - 'name': 'NIRFSG_VAL_SCRIPT_TRIGGER3', - 'value': 'scriptTrigger3' - } - ] - }, - 'SoftwareTriggerType': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'Specifies the Script Trigger.' - }, - 'name': 'NIRFSG_VAL_SCRIPT_TRIGGER', - 'value': 1 - }, - { - 'documentation': { - 'description': 'Specifies the Start Trigger.' - }, - 'name': 'NIRFSG_VAL_START_TRIGGER', - 'value': 0 - } - ] - }, - 'SparameterOrientation': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'Port 1 of the S2P is oriented towards the DUT port.' - }, - 'name': 'NIRFSG_VAL_PORT1_TOWARDS_DUT', - 'value': 24000 - }, - { - 'documentation': { - 'description': 'Port 2 of the S2P is oriented towards the DUT port.' - }, - 'name': 'NIRFSG_VAL_PORT2_TOWARDS_DUT', - 'value': 24001 - } - ] - }, - 'StartTrigDigEdgeEdge': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'Occurs when the signal transitions from low level to high level.' - }, - 'name': 'NIRFSG_VAL_RISING_EDGE', - 'value': 0 - }, - { - 'documentation': { - 'description': 'Occurs when the signal transitions from high level to low level.' - }, - 'name': 'NIRFSG_VAL_FALLING_EDGE', - 'value': 1 - } - ] - }, - 'StartTrigDigEdgeSource': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'The trigger is received on PFI 0.' - }, - 'name': 'NIRFSG_VAL_PFI0_STR', - 'value': 'PFI0' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI 1.' - }, - 'name': 'NIRFSG_VAL_PFI1_STR', - 'value': 'PFI1' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI 2.' - }, - 'name': 'NIRFSG_VAL_PFI2_STR', - 'value': 'PFI2' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI 3.' - }, - 'name': 'NIRFSG_VAL_PFI3_STR', - 'value': 'PFI3' - }, - { - 'documentation': { - 'description': 'The trigger is received on PXI trigger line 0.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG0_STR', - 'value': 'PXI_Trig0' - }, - { - 'documentation': { - 'description': 'The trigger is received on PXI trigger line 1.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG1_STR', - 'value': 'PXI_Trig1' - }, - { - 'documentation': { - 'description': 'The trigger is received on PXI trigger line 2.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG2_STR', - 'value': 'PXI_Trig2' - }, - { - 'documentation': { - 'description': 'The trigger is received on PXI trigger line 3.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG3_STR', - 'value': 'PXI_Trig3' - }, - { - 'documentation': { - 'description': 'The trigger is received on PXI trigger line 4.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG4_STR', - 'value': 'PXI_Trig4' - }, - { - 'documentation': { - 'description': 'The trigger is received on PXI trigger line 5.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG5_STR', - 'value': 'PXI_Trig5' - }, - { - 'documentation': { - 'description': 'The trigger is received on PXI trigger line 6.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG6_STR', - 'value': 'PXI_Trig6' - }, - { - 'documentation': { - 'description': 'The trigger is received on PXI trigger line 7.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG7_STR', - 'value': 'PXI_Trig7' - }, - { - 'documentation': { - 'description': 'The trigger is received on the PXI star trigger line. This value is not valid on the PXIe-5644/5645/5646.' - }, - 'name': 'NIRFSG_VAL_PXI_STAR_STR', - 'value': 'PXI_Star' - }, - { - 'documentation': { - 'description': 'The trigger is received on the PXI DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860.' - }, - 'name': 'NIRFSG_VAL_PXIE_DSTARB_STR', - 'value': 'PXIe_DStarB' - }, - { - 'documentation': { - 'description': 'The trigger is received on the TRIG IN/OUT terminal. This value is valid on only the PXIe-5654/5654 with PXIe-5696.' - }, - 'name': 'NIRFSG_VAL_TRIG_IN_STR', - 'value': 'TrigIn' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI0 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO0_STR', - 'value': 'DIO/PFI0' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI1 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO1_STR', - 'value': 'DIO/PFI1' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI2 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO2_STR', - 'value': 'DIO/PFI2' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI3 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO3_STR', - 'value': 'DIO/PFI3' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI4 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO4_STR', - 'value': 'DIO/PFI4' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI5 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO5_STR', - 'value': 'DIO/PFI5' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI6 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO6_STR', - 'value': 'DIO/PFI6' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI7 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO7_STR', - 'value': 'DIO/PFI7' - }, - { - 'documentation': { - 'description': 'The trigger is received on the Sync Start trigger line. This value is valid on only the PXIe-5644/5645/5646.' - }, - 'name': 'NIRFSG_VAL_SYNC_START_TRIGGER_STR', - 'value': 'Sync_Start' - } - ] - }, - 'StartTrigExportOutputTerm': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'The signal is not exported.' - }, - 'name': 'NIRFSG_VAL_DO_NOT_EXPORT_STR', - 'value': '' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0.' - }, - 'name': 'NIRFSG_VAL_PFI0_STR', - 'value': 'PFI0' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PFI 1 connector.' - }, - 'name': 'NIRFSG_VAL_PFI1_STR', - 'value': 'PFI1' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PFI 4 connector.' - }, - 'name': 'NIRFSG_VAL_PFI4_STR', - 'value': 'PFI4' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PFI 5 connector.' - }, - 'name': 'NIRFSG_VAL_PFI5_STR', - 'value': 'PFI5' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 0.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG0_STR', - 'value': 'PXI_Trig0' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 1.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG1_STR', - 'value': 'PXI_Trig1' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 2.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG2_STR', - 'value': 'PXI_Trig2' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 3.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG3_STR', - 'value': 'PXI_Trig3' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 4.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG4_STR', - 'value': 'PXI_Trig4' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 5.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG5_STR', - 'value': 'PXI_Trig5' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 6.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG6_STR', - 'value': 'PXI_Trig6' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860.' - }, - 'name': 'NIRFSG_VAL_PXIE_DSTARC_STR', - 'value': 'PXIe_DStarC' - }, - { - 'documentation': { - 'description': 'The signal is exported to the TRIG IN/OUT terminal. This value is valid on only the PXIe-5654/5654 with PXIe-5696.' - }, - 'name': 'NIRFSG_VAL_TRIG_OUT_STR', - 'value': 'TrigOut' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI0 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO0_STR', - 'value': 'DIO/PFI0' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI1 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO1_STR', - 'value': 'DIO/PFI1' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI2 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO2_STR', - 'value': 'DIO/PFI2' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI3 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO3_STR', - 'value': 'DIO/PFI3' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI4 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO4_STR', - 'value': 'DIO/PFI4' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI5 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO5_STR', - 'value': 'DIO/PFI5' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI6 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO6_STR', - 'value': 'DIO/PFI6' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI7 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO7_STR', - 'value': 'DIO/PFI7' - } - ] - }, - 'StartTrigType': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'No trigger is configured.' - }, - 'name': 'NIRFSG_VAL_NONE', - 'value': 0 - }, - { - 'documentation': { - 'description': 'The data operation does not start until a digital edge is detected. The source of the digital edge is specified with the %attribute{digital edge start trigger source} attribute, and the active edge is specified in the %attribute{digital edge start trigger edge} attribute.' - }, - 'name': 'NIRFSG_VAL_DIGITAL_EDGE', - 'value': 1 - }, - { - 'documentation': { - 'description': 'The data operation does not start until a software event occurs. You may create a software trigger by calling the %function{send software edge trigger} function.' - }, - 'name': 'NIRFSG_VAL_SOFTWARE', - 'value': 2 - }, - { - 'documentation': { - 'description': 'The data operation does not start until the endpoint reaches the threshold specified in the %attribute{p2p endpoint fullness start trigger level} attribute.' + 'description': 'The data operation does not start until the endpoint reaches the threshold specified in the NIRFSG_ATTR_P2P_ENDPOINT_FULLNESS_START_TRIGGER_LEVEL attribute.' }, 'name': 'NIRFSG_VAL_P2P_ENDPOINT_FULLNESS', 'value': 3 } ] }, - 'StartedEventExportOutputTerm': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'The signal is not exported.' - }, - 'name': 'NIRFSG_VAL_DO_NOT_EXPORT_STR', - 'value': '' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0.' - }, - 'name': 'NIRFSG_VAL_PFI0_STR', - 'value': 'PFI0' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PFI 1 connector.' - }, - 'name': 'NIRFSG_VAL_PFI1_STR', - 'value': 'PFI1' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PFI 4 connector.' - }, - 'name': 'NIRFSG_VAL_PFI4_STR', - 'value': 'PFI4' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PFI 5 connector.' - }, - 'name': 'NIRFSG_VAL_PFI5_STR', - 'value': 'PFI5' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 0.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG0_STR', - 'value': 'PXI_Trig0' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 1.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG1_STR', - 'value': 'PXI_Trig1' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 2.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG2_STR', - 'value': 'PXI_Trig2' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 3.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG3_STR', - 'value': 'PXI_Trig3' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 4.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG4_STR', - 'value': 'PXI_Trig4' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 5.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG5_STR', - 'value': 'PXI_Trig5' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXI trigger line 6.' - }, - 'name': 'NIRFSG_VAL_PXI_TRIG6_STR', - 'value': 'PXI_Trig6' - }, - { - 'documentation': { - 'description': 'The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860.' - }, - 'name': 'NIRFSG_VAL_PXIE_DSTARC_STR', - 'value': 'PXIe_DStarC' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI0 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO0_STR', - 'value': 'DIO/PFI0' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI1 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO1_STR', - 'value': 'DIO/PFI1' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI2 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO2_STR', - 'value': 'DIO/PFI2' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI3 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO3_STR', - 'value': 'DIO/PFI3' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI4 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO4_STR', - 'value': 'DIO/PFI4' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI5 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO5_STR', - 'value': 'DIO/PFI5' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI6 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO6_STR', - 'value': 'DIO/PFI6' - }, - { - 'documentation': { - 'description': 'The trigger is received on PFI7 from the front panel DIO terminal.' - }, - 'name': 'NIRFSG_VAL_DIO7_STR', - 'value': 'DIO/PFI7' - } - ] - }, 'StatusChecksDisabled': { 'values': [ { @@ -3723,74 +1736,26 @@ } ] }, - 'TriggerIdentifier': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'Specifies Script Trigger 0.' - }, - 'name': 'NIRFSG_VAL_SCRIPT_TRIGGER0', - 'value': 'scriptTrigger0' - }, - { - 'documentation': { - 'description': 'Specifies Script Trigger 1.' - }, - 'name': 'NIRFSG_VAL_SCRIPT_TRIGGER1', - 'value': 'scriptTrigger1' - }, - { - 'documentation': { - 'description': 'Specifies Script Trigger 2.' - }, - 'name': 'NIRFSG_VAL_SCRIPT_TRIGGER2', - 'value': 'scriptTrigger2' - }, - { - 'documentation': { - 'description': 'Specifies Script Trigger 3.' - }, - 'name': 'NIRFSG_VAL_SCRIPT_TRIGGER3', - 'value': 'scriptTrigger3' - }, - { - 'documentation': { - 'description': 'None (no signal to export)' - }, - 'name': 'NIRFSG_VAL_NONE_EMPTY_STRING', - 'value': '' - } - ] - }, 'UpconverterFrequencyOffsetMode': { 'codegen_method': 'public', 'values': [ { 'documentation': { - 'description': 'NI-RFSG places the upconverter center frequency outside of the signal bandwidth if the %attribute{signal bandwidth} attribute has been set and can be avoided.' + 'description': 'NI-RFSG places the upconverter center frequency outside of the signal bandwidth if the NIRFSG_ATTR_SIGNAL_BANDWIDTH attribute has been set and can be avoided.' }, 'name': 'NIRFSG_VAL_AUTO', 'value': -1 }, - { - 'name': 'NIRFSG_VAL_AUTOMATIC', - 'value': -1 - }, { 'documentation': { - 'description': 'NI-RFSG places the upconverter center frequency outside of the signal bandwidth if the %attribute{signal bandwidth} attribute has been set and can be avoided. NI-RFSG returns an error if the %attribute{signal bandwidth} attribute has not been set, or if the signal bandwidth is too large.' + 'description': 'NI-RFSG places the upconverter center frequency outside of the signal bandwidth if the NIRFSG_ATTR_SIGNAL_BANDWIDTH attribute has been set and can be avoided. NI-RFSG returns an error if the NIRFSG_ATTR_SIGNAL_BANDWIDTH attribute has not been set, or if the signal bandwidth is too large.' }, 'name': 'NIRFSG_VAL_ENABLE', 'value': 1 }, - { - 'name': 'NIRFSG_VAL_SCRIPT_TRIGGER', - 'value': 1 - }, { 'documentation': { - 'description': 'NI-RFSG uses the offset that you specified with the %attribute{upconverter frequency offset} or %attribute{upconverter center frequency} attributes.' + 'description': 'NI-RFSG uses the offset that you specified with the NIRFSG_ATTR_UPCONVERTER_FREQUENCY_OFFSET or NIRFSG_ATTR_UPCONVERTER_CENTER_FREQUENCY attributes.' }, 'name': 'NIRFSG_VAL_USER_DEFINED', 'value': 5001 diff --git a/src/nirfsg/metadata/functions.py b/src/nirfsg/metadata/functions.py index b3dd8ba68..0c8ce855d 100644 --- a/src/nirfsg/metadata/functions.py +++ b/src/nirfsg/metadata/functions.py @@ -7,7 +7,6 @@ 'description': ' Stops signal generation.\n\n **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `NI-RFSG Programming State Model `_\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -28,8 +27,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'AllocateArbWaveform': { 'codegen_method': 'public', @@ -37,7 +35,6 @@ 'description': ' Allocates onboard memory space for the arbitrary waveform. \n \n Use this function to specify the total size of a waveform before writing the data. Use this function only if you are calling the nirfsg_WriteArbWaveform function multiple times to write a large waveform in smaller blocks.\n\n The NI-RFSG device must be in the Configuration state before you call this function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Streaming Waveform Data `_\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -78,8 +75,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ChangeExternalCalibrationPassword': { 'codegen_method': 'public', @@ -87,7 +83,6 @@ 'description': ' Changes the external calibration password of the device.\n\n **Supported Devices:** PXIe-5611, PXIe-5653/5654, PXIe-5673/5673E, PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -128,8 +123,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'CheckAttributeViBoolean': { 'codegen_method': 'public', @@ -137,7 +131,6 @@ 'description': '\n Checks the validity of a value you specify for a ViBoolean attribute.\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -189,8 +182,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'CheckAttributeViInt32': { 'codegen_method': 'public', @@ -198,7 +190,6 @@ 'description': ' Checks the validity of a value you specify for a ViInt32 attribute.\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -251,8 +242,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'CheckAttributeViInt64': { 'codegen_method': 'public', @@ -260,7 +250,6 @@ 'description': ' \n Checks the validity of a value you specify for a ViInt64 attribute.\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -313,8 +302,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'CheckAttributeViReal64': { 'codegen_method': 'public', @@ -322,7 +310,6 @@ 'description': ' \n Checks the validity of a value you specify for a ViReal64 attribute.\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -375,8 +362,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'CheckAttributeViSession': { 'codegen_method': 'public', @@ -384,7 +370,6 @@ 'description': ' \n Checks the validity of a value you specify for a ViSession attribute.\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -436,8 +421,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'CheckAttributeViString': { 'codegen_method': 'public', @@ -445,7 +429,6 @@ 'description': '\n Checks the validity of a value you specify for a ViString attribute.\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -498,8 +481,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'CheckGenerationStatus': { 'codegen_method': 'public', @@ -507,7 +489,6 @@ 'description': '\n Checks the status of the generation. \n \n Call this function to check for any errors that might occur during the signal generation or to check whether the device has finished generating.\n\n **Supported Devices** : PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `NI-RFSG Instrument Driver Programming Flow `_\n\n `Stopping Pear-to-Peer Generation `_\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -552,16 +533,14 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'CheckIfScriptExists': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Returns whether the script that you specify as **NIRFSG_ATTR_SCRIPT_NAME** exists.\n\n **Supported Devices** : PXIe-5673/5673E. PXIe-5830/5831/5840/5841/5842/5860\n ' + 'description': ' \n Returns whether the script that you specify as NIRFSG_ATTR_SCRIPT_NAME exists.\n\n **Supported Devices** : PXIe-5673/5673E. PXIe-5830/5831/5840/5841/5842/5860\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -616,16 +595,14 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'CheckIfWaveformExists': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Returns whether the waveform that you specify as **NIRFSG_ATTR_WAVEFORM_NAME** exists.\n\n **Supported Devices** : PXIe-5673/5673E, PXIe-5830/5831/5840/5841/5842/5860\n ' + 'description': ' \n\n Returns whether the waveform that you specify as NIRFSG_ATTR_WAVEFORM_NAME exists.\n\n **Supported Devices** : PXIe-5673/5673E, PXIe-5830/5831/5840/5841/5842/5860\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -680,8 +657,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ClearAllArbWaveforms': { 'codegen_method': 'public', @@ -689,7 +665,6 @@ 'description': ' \n Deletes all currently defined waveforms and scripts. \n \n The NI-RFSG device must be in the Configuration state before you call this function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -710,8 +685,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ClearArbWaveform': { 'codegen_method': 'public', @@ -719,7 +693,6 @@ 'description': ' \n Deletes a specified waveform from the pool of currently defined waveforms. \n \n The NI-RFSG device must be in the Configuration state before you call this function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -750,8 +723,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ClearError': { 'codegen_method': 'public', @@ -760,7 +732,6 @@ '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, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -781,8 +752,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ClearSelfCalibrateRange': { 'codegen_method': 'public', @@ -790,7 +760,6 @@ 'description': ' \n Clears the data obtained from the nirfsg_SelfCalibrateRange function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -811,8 +780,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'Commit': { 'codegen_method': 'public', @@ -820,7 +788,6 @@ 'description': ' \n\n Programs the device with the correct settings. \n \n Calling this function moves the NI-RFSG device from the Configuration state to the Committed state. After this function executes, a change to any attribute reverts the NI-RFSG device to the Configuration state.\n\n **Supported devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `NI-RFSG Programming State Model `_\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -841,8 +808,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ConfigureDeembeddingTableInterpolationLinear': { 'codegen_method': 'public', @@ -850,7 +816,6 @@ 'description': ' Selects the linear interpolation method. \n \n If the carrier frequency does not match a row in the de-embedding table, NI-RFSG performs a linear interpolation based on the entries in the de-embedding table to determine the parameters to use for de-embedding.\n\n **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -924,8 +889,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ConfigureDeembeddingTableInterpolationNearest': { 'codegen_method': 'public', @@ -933,7 +897,6 @@ 'description': ' Selects the nearest interpolation method. \n \n NI-RFSG uses the parameters of the table nearest to the carrier frequency for de-embedding.\n\n **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -974,8 +937,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ConfigureDeembeddingTableInterpolationSpline': { 'codegen_method': 'public', @@ -983,7 +945,6 @@ 'description': ' Selects the spline interpolation method. \n \n If the carrier frequency does not match a row in the de-embedding table, NI-RFSG performs a spline interpolation based on the entries in the de-embedding table to determine the parameters to use for de-embedding.\n\n **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -1024,8 +985,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ConfigureDigitalEdgeScriptTrigger': { 'codegen_method': 'public', @@ -1033,7 +993,6 @@ 'description': ' Purpose\n\n Configures the specified Script Trigger for digital edge triggering. \n \n The NI-RFSG device must be in the Configuration state before calling this function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Script Trigger `_\n\n `Digital Edge Trigger `_\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -1084,8 +1043,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ConfigureDigitalEdgeStartTrigger': { 'codegen_method': 'public', @@ -1094,7 +1052,6 @@ 'note': 'For the PXIe-5654/5654 with PXIe-5696, the Start Trigger is valid only with a timer-based list when RF list mode is enabled.' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -1135,8 +1092,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ConfigureDigitalLevelScriptTrigger': { 'codegen_method': 'public', @@ -1144,7 +1100,6 @@ 'description': ' \n\n Configures a specified Script Trigger for digital level triggering. \n \n The NI-RFSG device must be in the Configuration state before calling this function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Script Trigger `_\n\n `Digital Level Trigger `_\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -1195,8 +1150,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ConfigureDigitalModulationUserDefinedWaveform': { 'codegen_method': 'public', @@ -1204,7 +1158,6 @@ 'description': ' \n Specifies the message signal used for digital modulation when the NIRFSG_ATTR_DIGITAL_MODULATION_WAVEFORM_TYPE attribute is set to NIRFSG_VAL_USER_DEFINED.\n\n **Supported Devices** : PXI/PXIe-5650/5651/5652\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -1249,8 +1202,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ConfigureGenerationMode': { 'codegen_method': 'public', @@ -1258,7 +1210,6 @@ 'description': '\n Configures the NI-RFSG device to generate a continuous sine tone (CW), apply I/Q (vector) modulation to the RF output signal, or generate arbitrary waveforms according to scripts. \n \n The NI-RFSG device must be in the Configuration state before you call this function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Assigning Properties or Attributes to a Waveform `_\n\n `Scripting Instructions `_--Refer to this topic for more information about VST restrictions on scripts.\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -1313,16 +1264,14 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ConfigureOutputEnabled': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Enables or disables signal output. \n \n Setting **NIRFSG_ATTR_OUTPUT_ENABLED** to VI_FALSE while in the Generation state attenuates the generated signal so that no signal is output.\n\n **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Output Enabled `_\n\n `NI-RFSG Instrument Driver Programming Flow `_\n\n `RF List Mode `_\n ' + 'description': ' \n\n Enables or disables signal output. \n \n Setting NIRFSG_ATTR_OUTPUT_ENABLED to VI_FALSE while in the Generation state attenuates the generated signal so that no signal is output.\n\n **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Output Enabled `_\n\n `NI-RFSG Instrument Driver Programming Flow `_\n\n `RF List Mode `_\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -1353,17 +1302,15 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ConfigureP2PEndpointFullnessStartTrigger': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Configures the Start Trigger to detect peer-to-peer endpoint fullness. \n \n Generation begins when the number of samples in the peer-to-peer endpoint reaches the threshold specified by the **NIRFSG_ATTR_P2P_ENDPOINT_FULLNESS_LEVEL** parameter. The NI-RFSG device must be in the Configuration state before calling this function.\n\n **Supported Devices** : PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Start Trigger `_\n ', + 'description': ' \n Configures the Start Trigger to detect peer-to-peer endpoint fullness. \n \n Generation begins when the number of samples in the peer-to-peer endpoint reaches the threshold specified by the NIRFSG_ATTR_P2P_ENDPOINT_FULLNESS_LEVEL parameter. The NI-RFSG device must be in the Configuration state before calling this function.\n\n **Supported Devices** : PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Start Trigger `_\n ', 'note': 'Due to an additional internal FIFO in the RF signal generator, the writer peer actually writes 2,304 bytes more than the quantity of data specified by this function to satisfy the trigger level.' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -1394,8 +1341,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ConfigurePowerLevelType': { 'codegen_method': 'public', @@ -1403,7 +1349,6 @@ 'description': ' \n\n Specifies the way the driver interprets the NIRFSG_ATTR_POWER_LEVEL attribute. \n \n In average power mode, NI-RFSG automatically scales waveform data to use the maximum dynamic range. In peak power mode, waveforms are scaled according to the NIRFSG_ATTR_ARB_WAVEFORM_SOFTWARE_SCALING_FACTOR attribute.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Spurious Performance `_\n\n `Optimizing for Low Power Generation `_\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -1451,8 +1396,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ConfigurePxiChassisClk10': { 'codegen_method': 'public', @@ -1460,7 +1404,6 @@ 'description': ' \n\n Specifies the signal to drive the 10MHz Reference Clock on the PXI backplane. \n \n This option can only be configured when the PXI-5610 is in Slot 2 of the PXI chassis. The NI-RFSG device must be in the Configuration state before you call this function.\n\n **Supported Devices** : PXI-5610, PXI-5670/5671\n\n **Related Topics**\n\n `Timing Configurations `_\n\n `System Reference Clock `_\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -1491,8 +1434,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ConfigureRF': { 'codegen_method': 'public', @@ -1500,7 +1442,6 @@ 'description': ' \n Configures the frequency and power level of the RF output signal. \n \n The PXI-5670/5671, PXIe-5672, and PXIe-5860 device must be in the Configuration state before calling this function. The PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696, PXIe-5673/5673E, and PXIe-5830/5831/5832/5840/5841/5842 device can be in the Configuration or Generation state when you call this function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `NI-RFSG Instrument Driver Programming Flow `_\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -1541,8 +1482,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ConfigureRefClock': { 'codegen_method': 'public', @@ -1550,7 +1490,6 @@ 'description': ' \n\n Configures the NI-RFSG device Reference Clock. \n \n The Reference Clock ensures that the NI-RFSG devices are operating from a common timebase. The NI-RFSG device must be in the Configuration state before calling this function.\n\n **Supported Devices** : PXI-5610, PXIe-5644/5645/5646, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `PXIe-5672 Timing Configurations `_\n\n `PXIe-5673 Timing Configurations `_\n\n `PXIe-5673E Timing Configurations `_\n\n `PXIe-5830 Timing Configurations `_\n\n `PXIe-5831 Timing Configurations `_\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -1573,7 +1512,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the source of Reference Clock signal.\n ', + 'description': 'Specifies the source of Reference Clock signal.', 'table_body': [ [ 'NIRFSG_VAL_ONBOARD_CLOCK_STR (default)', @@ -1598,7 +1537,7 @@ [ 'NIRFSG_VAL_REF_IN_2_STR', 'RefIn2', - '-' + '\\-' ], [ 'NIRFSG_VAL_PXI_CLK_MASTER_STR', @@ -1620,7 +1559,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the Reference Clock rate, in hertz (Hz), of the signal present at the REF IN or CLK IN connector. The default value is NIRFSG_VAL_AUTO, which allows NI-RFSG to use the default Reference Clock rate for the device or automatically detect the Reference Clock rate, if supported. This parameter is only valid when the **NIRFSG_ATTR_REF_CLOCK_SOURCE** parameter is set to NIRFSG_VAL_CLK_IN_STR, NIRFSG_VAL_REF_IN_STR or NIRFSG_VAL_REF_IN_2_STR. Refer to the NIRFSG_ATTR_REF_CLOCK_RATE attribute for possible values.' + 'description': 'Specifies the Reference Clock rate, in hertz (Hz), of the signal present at the REF IN or CLK IN connector. The default value is NIRFSG_VAL_AUTO, which allows NI-RFSG to use the default Reference Clock rate for the device or automatically detect the Reference Clock rate, if supported. This parameter is only valid when the NIRFSG_ATTR_REF_CLOCK_SOURCE parameter is set to NIRFSG_VAL_CLK_IN_STR, NIRFSG_VAL_REF_IN_STR or NIRFSG_VAL_REF_IN_2_STR. Refer to the NIRFSG_ATTR_REF_CLOCK_RATE attribute for possible values.' }, 'name': 'refClockRate', 'type': 'ViReal64', @@ -1628,8 +1567,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ConfigureSignalBandwidth': { 'codegen_method': 'public', @@ -1638,7 +1576,6 @@ 'note': 'Based on your signal bandwidth, NI-RFSG decides whether to configure the upconverter center frequency on the PXI-5670/5671 or PXIe-5672 in increments of 1MHz or 5MHz. Failure to configure signal bandwidth may result in the signal being placed outside the upconverter passband.' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -1669,8 +1606,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ConfigureSoftwareScriptTrigger': { 'codegen_method': 'public', @@ -1678,7 +1614,6 @@ 'description': ' \n Configures the Script Trigger for software triggering. \n \n Refer to the nirfsg_SendSoftwareEdgeTrigger function for more information about using the software Script Trigger. The NI-RFSG device must be in the Configuration state before calling this function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Script Trigger `_\n\n `Trigger Types `_\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -1709,8 +1644,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ConfigureSoftwareStartTrigger': { 'codegen_method': 'public', @@ -1718,7 +1652,6 @@ 'description': ' \n\n Configures the Start Trigger for software triggering. \n \n Refer to the nirfsg_SendSoftwareEdgeTrigger function for more information about using a software trigger. The NI-RFSG device must be in the Configuration state before calling this function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n\n\n **Related Topics**\n\n `Start Trigger `_\n\n `Trigger Types `_\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -1739,8 +1672,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'CreateDeembeddingSparameterTableS2PFile': { 'codegen_method': 'public', @@ -1748,7 +1680,6 @@ 'description': ' Creates an S-parameter de-embedding table for the port based on the specified S2P file.\n\n If you only create one table for a port, NI-RFSG automatically selects that table to de-embed the measurement.\n\n **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `De-embedding Overview `_\n\n `S-parameters `_\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -1827,8 +1758,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'DeleteAllDeembeddingTables': { 'codegen_method': 'public', @@ -1836,7 +1766,6 @@ 'description': ' Deletes all configured de-embedding tables for the session.\n\n **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -1857,8 +1786,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'DeleteDeembeddingTable': { 'codegen_method': 'public', @@ -1866,7 +1794,6 @@ 'description': ' Deletes the selected de-embedding table for a given port.\n\n **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -1907,8 +1834,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'Disable': { 'codegen_method': 'public', @@ -1916,7 +1842,6 @@ 'description': ' \n Places the instrument in a quiescent state where it has minimal or no impact on the system to which it is connected.\n\n **Supported Devices** : PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXI-5670/5671, PXIe-5672/5673/5673E\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -1937,8 +1862,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'DisableScriptTrigger': { 'codegen_method': 'public', @@ -1946,7 +1870,6 @@ 'description': ' \n Configures the device not to wait for the specified Script Trigger. \n \n Call this function only if you previously configured a Script Trigger and now want it disabled. The NI-RFSG device must be in the Configuration state before you call this function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Script Trigger `_\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -1977,8 +1900,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'DisableStartTrigger': { 'codegen_method': 'public', @@ -1986,7 +1908,6 @@ 'description': ' \n\n Configures the device not to wait for a Start Trigger. \n \n This function is necessary only if you previously configured a Start Trigger and now want it disabled. The NI-RFSG device must be in the Configuration state before calling this function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXIe-5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Start Trigger `_\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -2007,8 +1928,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ExportSignal': { 'codegen_method': 'public', @@ -2016,7 +1936,6 @@ 'description': ' \n\n Routes signals (triggers, clocks, and events) to a specified output terminal. \n \n The NI-RFSG device must be in the Configuration state before you call this function.\n\n You can clear a previously routed signal by exporting the signal to "" (empty string).\n\n **Supported Devices** :PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Triggers `_\n\n `Events `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -2097,56 +2016,46 @@ { 'direction': 'in', 'documentation': { - 'description': "Specifies which instance of the selected signal to export. This parameter is useful when you set the NIRFSG_ATTR_SIGNAL parameter to NIRFSG_VAL_SCRIPT_TRIGGER or NIRFSG_VAL_MARKER_EVENT. Otherwise, set the NIRFSG_ATTR_SIGNAL_IDENTIFIER parameter to '' (empty string). **Defined Values** :", + 'description': "Specifies which instance of the selected signal to export. This parameter is useful when you set the NIRFSG_ATTR_SIGNAL parameter to NIRFSG_VAL_SCRIPT_TRIGGER or NIRFSG_VAL_MARKER_EVENT. Otherwise, set the NIRFSG_ATTR_SIGNAL_IDENTIFIER parameter to '' (empty string). **Possible Values** :", 'table_body': [ [ - 'NIRFSG_VAL_MARKER_EVENT0', 'marker0', 'Specifies Marker 0.' ], [ - 'NIRFSG_VAL_MARKER_EVENT1', 'marker1', 'Specifies Marker 1.' ], [ - 'NIRFSG_VAL_MARKER_EVENT2', 'marker2', 'Specifies Marker 2.' ], [ - 'NIRFSG_VAL_MARKER_EVENT3', 'marker3', 'Specifies Marker 3.' ], [ - 'NIRFSG_VAL_SCRIPT_TRIGGER0', 'scriptTrigger0', 'Specifies Script Trigger 0.' ], [ - 'NIRFSG_VAL_SCRIPT_TRIGGER1', 'scriptTrigger1', 'Specifies Script Trigger 1.' ], [ - 'NIRFSG_VAL_SCRIPT_TRIGGER2', 'scriptTrigger2', 'Specifies Script Trigger 2.' ], [ - 'NIRFSG_VAL_SCRIPT_TRIGGER3', 'scriptTrigger3', 'Specifies Script Trigger 3.' ] ], 'table_header': [ - 'Name', - 'Value', + 'Possible Value', 'Description' ] }, - 'enum': 'SignalIdentifier', 'name': 'signalIdentifier', 'type': 'ViConstString', 'use_array': False, @@ -2155,48 +2064,162 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the terminal where the signal is exported. You can choose not to export any signal. For the PXIe-5841 with PXIe-5655, the signal is exported to the terminal on the PXIe-5841. **Defined Values** :', + 'description': 'Specifies the terminal where the signal is exported. You can choose not to export any signal. For the PXIe-5841 with PXIe-5655, the signal is exported to the terminal on the PXIe-5841. **Possible Values** :', 'table_body': [ [ - 'NIRFSG_VAL_CLK_OUT_STR', 'ClkOut', - 'Exports the Reference Clock signal to the CLK OUT connector of the device.', - 'Supported on PXIe-5673, 5673E' + 'Exports the Reference Clock signal to the CLK OUT connector of the device.' ], [ - 'NIRFSG_VAL_DO_NOT_EXPORT_STR', '', - 'The Reference Clock signal is not exported.', - 'Supported on PXIe-5644/5645/5646, 5820/5830/5831/5832/5840/5841/5842/5860, 5650/5651/5652, 5654, 5673, 5673E, PXIe-5654 with PXIe-5696, PXI-5650/5651/5652 (See Note)' + 'The Reference Clock signal is not exported.' ], [ - 'NIRFSG_VAL_REF_OUT_STR', 'RefOut', - 'Exports the Reference Clock signal to the REF OUT connector of the device.', - 'Supported on PXIe-5644/5645/5646, 5820/5830/5831/5832/5840/5841/5842/5860, 5650/5651/5653, 5653, 5654, 5673, 5673E, PXIe-5654 with PXIe-5696, PXI-5650/5651/5653, ' + 'Exports the Reference Clock signal to the REF OUT connector of the device.' ], [ - 'NIRFSG_VAL_REF_OUT2_STR', 'RefOut2', - 'Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable.', - 'Supported on PXIe-5650/5651/5652, 5654, 5673E, PXIe-5654 with PXIe-5696' + 'Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable.' ] ], 'table_header': [ - 'Name', - 'Value', + 'Possible Value', 'Description' ] }, - 'enum': 'ReferenceClockExportOutputTerminal', 'name': 'outputTerminal', 'type': 'ViConstString', 'use_array': False, 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' + }, + 'GetAllNamedWaveformNames': { + 'codegen_method': 'public', + 'documentation': { + 'description': '\n Return names of the waveforms present in the memory.\n\n **Supported Devices** :PXIe-5830/5831/5840/5841/5842E\n ' + }, + '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 a string having waveform names separated by commas.' + }, + 'name': 'waveformNames', + 'python_api_converter_name': 'convert_comma_separated_string_to_list', + 'size': { + 'mechanism': 'ivi-dance', + 'value': 'bufferSize' + }, + 'type': 'ViChar[]', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': ' Pass the number of bytes in the ViChar buffer you specify for the NIRFSG_ATTR_WAVEFORM_NAMES parameter.\n\n If you pass 0, you can pass VI_NULL for the NIRFSG_ATTR_WAVEFORM_NAMES parameter.\n ' + }, + 'name': 'bufferSize', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': ' Fetch the number of bytes needed to pass in the NIRFSG_ATTR_BUFFER_SIZE parameter.\n\n It can be fetch by passing VI_NULL in the NIRFSG_ATTR_WAVEFORM_NAMES parameter.\n ' + }, + 'name': 'actualBufferSize', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus' + }, + 'GetAllScriptNames': { + 'codegen_method': 'public', + 'documentation': { + 'description': ' \n\n Return names of the scripts present in the memory.\n\n **Supported Devices** :PXIe-5830/5831/5840/5841/5842E\n ' + }, + '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 a string having script names separated by commas.' + }, + 'name': 'scriptNames', + 'size': { + 'mechanism': 'ivi-dance', + 'value': 'bufferSize' + }, + 'type': 'ViChar[]', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': ' Pass the number of bytes in the ViChar buffer you specify for the **waveformNames** parameter.\n\n If you pass 0, you can pass VI_NULL for the **waveformNames** parameter.\n ' + }, + 'name': 'bufferSize', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': ' Fetch the number of bytes needed to pass in the NIRFSG_ATTR_BUFFER_SIZE parameter.\n\n It can be fetch by passing VI_NULL in the NIRFSG_ATTR_SCRIPT_NAMES parameter.\n ' + }, + 'name': 'actualBufferSize', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus' }, 'GetAttributeViBoolean': { 'codegen_method': 'private', @@ -2204,7 +2227,6 @@ 'description': ' \n Queries the value of a ViBoolean attribute.\n\n Use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n - State caching is disabled for the entire session or for the particular attribute.\n - State caching is enabled, and the currently cached value is invalid.\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -2255,8 +2277,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'GetAttributeViInt32': { 'codegen_method': 'private', @@ -2264,7 +2285,6 @@ 'description': ' \n\n Queries the value of a ViInt32 attribute.\n\n Use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n - State caching is disabled for the entire session or for the particular attribute.\n - State caching is enabled, and the currently cached value is invalid.\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -2315,8 +2335,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'GetAttributeViInt64': { 'codegen_method': 'private', @@ -2324,7 +2343,6 @@ 'description': ' \n Queries the value of a ViInt64 attribute.\n\n You can use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n - State caching is disabled for the entire session or for the particular attribute.\n - State caching is enabled, and the currently cached value is invalid.\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -2375,8 +2393,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'GetAttributeViReal64': { 'codegen_method': 'private', @@ -2384,7 +2401,6 @@ 'description': ' \n \n Queries the value of a ViReal64 attribute.\n\n Use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n - State caching is disabled for the entire session or for the particular attribute.\n - State caching is enabled, and the currently cached value is invalid.\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -2435,8 +2451,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'GetAttributeViSession': { 'codegen_method': 'private', @@ -2444,7 +2459,6 @@ 'description': ' \n Queries the value of a ViSession attribute.\n\n Use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n - State caching is disabled for the entire session or for the particular attribute.\n - State caching is enabled, and the currently cached value is invalid.\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -2495,8 +2509,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'GetAttributeViString': { 'codegen_method': 'private', @@ -2504,7 +2517,6 @@ 'description': ' \n \n\n Queries the value of a ViString attribute.\n\n Use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n - State caching is disabled for the entire session or for the particular attribute.\n - State caching is enabled, and the currently cached value is invalid.\n\n You must provide a ViString (ViChar array) to serve as a buffer for the value. Pass the number of bytes in the buffer as the Buffer Size parameter. If the current value of the attribute, including the terminating NULL byte, is larger than the size you indicate in the buffer size parameter, the function copies buffer size-1 bytes into the buffer, places an ASCII NULL byte at the end of the buffer, and returns the buffer size you must pass to get the entire value. For example, if the value is "123456" and the buffer size is 4, the function places "123" into the buffer and returns 7.\n\n To call this function to get only the required buffer size, pass 0 for the buffer size and VI_NULL for the attribute value buffer.\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -2569,23 +2581,20 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, - 'GetError': { + 'GetChannelName': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Retrieves and then clears the IVI error information for the session or the current execution thread.\n\n **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860\n ', - 'note': 'If the **bufferSize** parameter is 0, this function does not clear the error information. By passing 0 to the **bufferSize** parameter, you can determine the buffer size required to obtain the entire NIRFSG_ATTR_ERROR_DESCRIPTION string. You can then call this function again with a sufficiently large buffer. If you specify a valid IVI session for the NIRFSG_ATTR_VI parameter, this function retrieves and clears the error information for the session. If you pass VI_NULL for the NIRFSG_ATTR_VI parameter, this function retrieves and clears the error information for the current execution thread. If the NIRFSG_ATTR_VI parameter is an invalid session, this function does nothing and returns an error. Normally, the error information describes the first error that occurred since the user last called this function or the niRFSG_ClearError function.' + 'description': ' Returns the channel string that is in the channel table at an index you specify.\n\n **Supported Devices** : PXI-5670/5671, PXIe-5672/5673/5673E\n ' }, 'included_in_proto': True, - 'is_error_handling': True, 'method_templates': [ { 'documentation_filename': 'default_method', 'library_interpreter_filename': 'default_method', 'method_python_name_suffix': '', - 'session_filename': 'none' + 'session_filename': 'default_method' } ], 'parameters': [ @@ -2600,22 +2609,21 @@ 'use_in_python_api': True }, { - 'direction': 'out', + 'direction': 'in', 'documentation': { - 'description': 'Returns the error code for the session or execution thread. If you pass 0 for the **BufferSize** parameter, you can pass VI_NULL for this parameter.' + 'description': 'Specifies a one-based index into the channel table.' }, - 'name': 'errorCode', - 'type': 'ViStatus', + 'name': 'index', + 'type': 'ViInt32', 'use_array': False, 'use_in_python_api': True }, { - 'default_value': '256', 'direction': 'in', 'documentation': { - 'description': ' Pass the number of bytes in the ViChar array you specify for the **description** parameter.\n\n If the NIRFSG_ATTR_ERROR_DESCRIPTION, including the terminating NULL byte, contains more bytes than you indicate in this parameter, the function copies **bufferSize** - 1 bytes into the buffer, places an ASCII NULL byte at the end of the buffer, and returns the buffer size you must pass to get the entire value. Forexample, if the value is 123456 and the buffer size is 4, the function places 123 into the buffer and returns 7. If you pass 0, you can pass VI_NULL for the **description** parameter.\n\n **Default Value** : None\n\n ' + 'description': 'Specifies the size of the buffer for the channel string.' }, - 'name': 'errorDescriptionBufferSize', + 'name': 'bufferSize', 'type': 'ViInt32', 'use_array': False, 'use_in_python_api': True @@ -2623,35 +2631,34 @@ { 'direction': 'out', 'documentation': { - 'description': ' Returns the NIRFSG_ATTR_ERROR_DESCRIPTION for the IVI session or execution thread.\n\n If there is no description, the function returns an empty string. The buffer must contain at least as many elements as the value you specify with the **bufferSize** parameter. If the NIRFSG_ATTR_ERROR_DESCRIPTION, including the terminating NULL byte, contains more bytes than you indicate with the **bufferSize** parameter, the function copies **bufferSize** - 1 bytes into the buffer, places an ASCII NULL byte at the end of the buffer, and returns the buffer size you must pass to get the entire value. For example, if the value is 123456 and the buffer size is 4, the function places 123 into the buffer and returns 7. If you pass 0, you can pass VI_NULL for this parameter.\n\n ' + 'description': 'Returns 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': 'errorDescription', + 'name': 'name', 'size': { 'mechanism': 'ivi-dance', - 'value': 'errorDescriptionBufferSize' + 'value': 'bufferSize' }, 'type': 'ViChar[]', 'use_array': False, 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, - 'GetExternalCalibrationLastDateAndTime': { - 'codegen_method': 'private', + 'GetError': { + 'codegen_method': 'public', 'documentation': { - 'description': ' \n Returns the date and time of the last successful external calibration. \n \n The time returned is 24-hour (military) local time; for example, if the device was calibrated at 2:30PM, this function returns\n\n 14 for the hours parameter and\n\n 30 for the minutes parameter.\n\n **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' + 'description': ' \n Retrieves and then clears the IVI error information for the session or the current execution thread.\n\n **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860\n ', + 'note': 'If the **bufferSize** parameter is 0, this function does not clear the error information. By passing 0 to the **bufferSize** parameter, you can determine the buffer size required to obtain the entire NIRFSG_ATTR_ERROR_DESCRIPTION string. You can then call this function again with a sufficiently large buffer. If you specify a valid IVI session for the NIRFSG_ATTR_VI parameter, this function retrieves and clears the error information for the session. If you pass VI_NULL for the NIRFSG_ATTR_VI parameter, this function retrieves and clears the error information for the current execution thread. If the NIRFSG_ATTR_VI parameter is an invalid session, this function does nothing and returns an error. Normally, the error information describes the first error that occurred since the user last called this function or the niRFSG_ClearError function.' }, 'included_in_proto': True, - 'is_error_handling': False, - 'method_name_for_documentation': 'get_external_calibration_last_date_and_time', + 'is_error_handling': True, 'method_templates': [ { 'documentation_filename': 'default_method', 'library_interpreter_filename': 'default_method', 'method_python_name_suffix': '', - 'session_filename': 'default_method' + 'session_filename': 'none' } ], 'parameters': [ @@ -2668,19 +2675,20 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the year of the last successful calibration.' + 'description': 'Returns the error code for the session or execution thread. If you pass 0 for the **BufferSize** parameter, you can pass VI_NULL for this parameter.' }, - 'name': 'year', - 'type': 'ViInt32', + 'name': 'errorCode', + 'type': 'ViStatus', 'use_array': False, 'use_in_python_api': True }, { - 'direction': 'out', + 'default_value': '256', + 'direction': 'in', 'documentation': { - 'description': 'Returns the month of the last successful calibration.' + 'description': ' Pass the number of bytes in the ViChar array you specify for the **description** parameter.\n\n If the NIRFSG_ATTR_ERROR_DESCRIPTION, including the terminating NULL byte, contains more bytes than you indicate in this parameter, the function copies **bufferSize** - 1 bytes into the buffer, places an ASCII NULL byte at the end of the buffer, and returns the buffer size you must pass to get the entire value. Forexample, if the value is 123456 and the buffer size is 4, the function places 123 into the buffer and returns 7. If you pass 0, you can pass VI_NULL for the **description** parameter.\n\n **Default Value** : None\n\n ' }, - 'name': 'month', + 'name': 'errorDescriptionBufferSize', 'type': 'ViInt32', 'use_array': False, 'use_in_python_api': True @@ -2688,14 +2696,70 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the day of the last successful calibration.' + 'description': ' Returns the NIRFSG_ATTR_ERROR_DESCRIPTION for the IVI session or execution thread.\n\n If there is no description, the function returns an empty string. The buffer must contain at least as many elements as the value you specify with the **bufferSize** parameter. If the NIRFSG_ATTR_ERROR_DESCRIPTION, including the terminating NULL byte, contains more bytes than you indicate with the **bufferSize** parameter, the function copies **bufferSize** - 1 bytes into the buffer, places an ASCII NULL byte at the end of the buffer, and returns the buffer size you must pass to get the entire value. For example, if the value is 123456 and the buffer size is 4, the function places 123 into the buffer and returns 7. If you pass 0, you can pass VI_NULL for this parameter.\n\n ' }, - 'name': 'day', - 'type': 'ViInt32', - 'use_array': False, - 'use_in_python_api': True - }, - { + 'name': 'errorDescription', + 'size': { + 'mechanism': 'ivi-dance', + 'value': 'errorDescriptionBufferSize' + }, + 'type': 'ViChar[]', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': False + }, + 'GetExternalCalibrationLastDateAndTime': { + 'codegen_method': 'private', + 'documentation': { + 'description': ' \n Returns the date and time of the last successful external calibration. \n \n The time returned is 24-hour (military) local time; for example, if the device was calibrated at 2:30PM, this function returns\n\n 14 for the hours parameter and\n\n 30 for the minutes parameter.\n\n **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' + }, + 'included_in_proto': True, + 'method_name_for_documentation': 'get_external_calibration_last_date_and_time', + '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 year of the last successful calibration.' + }, + 'name': 'year', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the month of the last successful calibration.' + }, + 'name': 'month', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the day of the last successful calibration.' + }, + 'name': 'day', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { 'direction': 'out', 'documentation': { 'description': 'Returns the hour of the last successful calibration.' @@ -2726,8 +2790,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'GetLastExtCalLastDateAndTime': { 'codegen_method': 'python-only', @@ -2757,8 +2820,7 @@ ], 'python_name': 'get_external_calibration_last_date_and_time', 'real_datetime_call': 'GetExternalCalibrationLastDateAndTime', - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'GetLastSelfCalLastDateAndTime': { 'codegen_method': 'python-only', @@ -2788,8 +2850,7 @@ ], 'python_name': 'get_self_calibration_last_date_and_time', 'real_datetime_call': 'GetSelfCalibrationDateAndTime', - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'GetMaxSettablePower': { 'codegen_method': 'public', @@ -2797,7 +2858,6 @@ 'description': ' \n\n Returns the maximum settable output power level for the current configuration.\n\n **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -2828,8 +2888,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'GetSelfCalibrationDateAndTime': { 'codegen_method': 'private', @@ -2837,16 +2896,7 @@ 'description': '\n Returns the date and time of the last successful self-calibration. \n \n The time returned is 24-hour local time. For example, if the device was calibrated at 2:30PM, this function returns\n\n 14 for the hours parameter and\n\n 30 for the minutes parameter.\n\n **Supported Devices** : PXI-5610, PXIe-5644/5645/5646, PXIe-5653, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_name_for_documentation': 'get_self_calibration_date_and_time', - 'method_templates': [ - { - 'documentation_filename': 'default_method', - 'library_interpreter_filename': 'default_method', - 'method_python_name_suffix': '', - 'session_filename': 'default_method' - } - ], 'parameters': [ { 'direction': 'in', @@ -2929,8 +2979,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'GetSelfCalibrationTemperature': { 'codegen_method': 'public', @@ -2938,7 +2987,6 @@ 'description': ' \n Returns the temperature, in degrees Celsius, of the device at the last successful self-calibration.\n\n **Supported Devices** : PXI-5610, PXIe-5653, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831 (IF only)/5832 (IF only)/5840/5841/5842/5860\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -3002,8 +3050,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'GetStreamEndpointHandle': { 'codegen_method': 'public', @@ -3011,7 +3058,6 @@ 'description': ' \n\n Returns a reader endpoint handle that can be used with NI-P2P to configure a peer-to-peer stream with an RF signal generator endpoint.\n\n **Supported Devices** : PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Configuring a Peer-to-Peer Stream `_\n\n `Configuring Flow Control `_\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -3052,86 +3098,14 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False - }, - 'GetWaveformBurstStartLocations': { - 'codegen_method': 'private', - 'documentation': { - 'description': ' \n Returns the burst start locations of the waveform stored in the NI-RFSG session.\n\n **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842\n ' - }, - 'included_in_proto': True, - 'is_error_handling': False, - 'method_templates': [ - { - 'documentation_filename': 'default_method', - 'library_interpreter_filename': 'default_method', - 'method_python_name_suffix': '', - 'session_filename': 'default_method' - } - ], - 'parameters': [ - { - 'direction': 'in', - 'documentation': { - 'description': 'Identifies your instrument session. 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. Example: "waveform::waveform0/marker0"' - }, - 'name': 'channelName', - 'type': 'ViConstString', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Specifies the size of the burst start locations array.' - }, - 'name': 'numberOfLocations', - 'type': 'ViInt32', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'out', - 'documentation': { - 'description': 'Returns the burst start locations stored in the NI-RFSG session for the waveform that you specified in the **NIRFSG_ATTR_CHANNEL_NAME** parameter. This value is expressed in samples.' - }, - 'name': 'locations', - 'type': 'ViReal64', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'out', - 'documentation': { - 'description': 'Returns the required size for the output array if you pass NULL to NIRFSG_ATTR_LOCATIONS parameter.' - }, - 'name': 'requiredSize', - 'type': 'ViInt32', - 'use_array': False, - 'use_in_python_api': True - } - ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, - 'GetWaveformBurstStopLocations': { - 'codegen_method': 'private', + 'GetTerminalName': { + 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Returns the burst stop locations of the waveform stored in the NI-RFSG session.\n\n **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842\n ' + 'description': '\n Returns the fully-qualified name of the specified signal. \n \n The fully-qualified name is helpful to automatically route signals in a multisegment chassis.\n\n **Supported Devices** : PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Triggers `_\n\n `Events `_\n\n `Syntax for Terminal Names `_\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -3154,79 +3128,105 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the waveform name and the marker name. Example: "waveform::waveform0/marker0"' - }, - 'name': 'channelName', - 'type': 'ViConstString', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Specifies the size of the burst start locations array.' - }, - 'name': 'numberOfLocations', - 'type': 'ViInt32', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'out', - 'documentation': { - 'description': 'Returns the burst start locations stored in the NI-RFSG session for the waveform that you specified in the **NIRFSG_ATTR_CHANNEL_NAME** parameter. This value is expressed in samples.' - }, - 'name': 'locations', - 'type': 'ViReal64', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'out', - 'documentation': { - 'description': 'Returns the required size for the output array if you pass NULL to NIRFSG_ATTR_LOCATIONS parameter.' + 'description': 'Specifies the signal to query. **Defined Values** :\n ', + 'table_body': [ + [ + 'NIRFSG_VAL_START_TRIGGER', + '0 (0x0)', + 'Exports a Start Trigger.' + ], + [ + 'NIRFSG_VAL_SCRIPT_TRIGGER', + '1 (0x1)', + 'Exports a Script Trigger.' + ], + [ + 'NIRFSG_VAL_MARKER_EVENT', + '2 (0x2)', + 'Exports a Marker Event.' + ], + [ + 'NIRFSG_VAL_REF_CLOCK', + '3 (0x3)', + 'Exports the Reference Clock.' + ], + [ + 'NIRFSG_VAL_STARTED_EVENT', + '4 (0x4)', + 'Exports a Started Event.' + ], + [ + 'NIRFSG_VAL_DONE_EVENT', + '5 (0x5)', + 'Exports a Done Event.' + ], + [ + 'NIRFSG_VAL_CONFIGURATION_LIST_STEP_TRIGGER', + '6 (0x6)', + 'Exports a Configuration List Step Trigger.' + ], + [ + 'NIRFSG_VAL_CONFIGURATION_SETTLED_EVENT', + '7 (0x7)', + 'Exports a Configuration Settled Event.' + ] + ], + 'table_header': [ + 'Name', + 'Value', + 'Description' + ] }, - 'name': 'requiredSize', + 'enum': 'Signal', + 'name': 'signal', 'type': 'ViInt32', 'use_array': False, 'use_in_python_api': True - } - ], - 'returns': 'ViStatus', - 'use_session_lock': False - }, - 'GetWaveformMarkerEventLocations': { - 'codegen_method': 'private', - 'documentation': { - 'description': ' \n Returns the marker locations associated with the waveform and the marker stored in the NI-RFSG session.\n\n **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842\n ' - }, - 'included_in_proto': True, - 'is_error_handling': False, - 'method_templates': [ - { - 'documentation_filename': 'default_method', - 'library_interpreter_filename': 'default_method', - 'method_python_name_suffix': '', - 'session_filename': 'default_method' - } - ], - 'parameters': [ - { - 'direction': 'in', - 'documentation': { - 'description': 'Identifies your instrument session. 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\n Example:\n\n "waveform::waveform0/marker0"\n ' + 'description': "Specifies which instance of the selected signal to query. This parameter is necessary when you set the NIRFSG_ATTR_SIGNAL parameter to NIRFSG_VAL_SCRIPT_TRIGGER or NIRFSG_VAL_MARKER_EVENT . Otherwise, set the NIRFSG_ATTR_SIGNAL_IDENTIFIER parameter to '' (empty string). **Possible Values** :\n ", + 'table_body': [ + [ + 'marker0', + 'Specifies Marker 0.' + ], + [ + 'marker1', + 'Specifies Marker 1.' + ], + [ + 'marker2', + 'Specifies Marker 2.' + ], + [ + 'marker3', + 'Specifies Marker 3.' + ], + [ + 'scriptTrigger0', + 'Specifies Script Trigger 0.' + ], + [ + 'scriptTrigger1', + 'Specifies Script Trigger 1.' + ], + [ + 'scriptTrigger2', + 'Specifies Script Trigger 2.' + ], + [ + 'scriptTrigger3', + 'Specifies Script Trigger 3.' + ] + ], + 'table_header': [ + 'Possible Value', + 'Description' + ] }, - 'name': 'channelName', + 'name': 'signalIdentifier', 'type': 'ViConstString', 'use_array': False, 'use_in_python_api': True @@ -3234,9 +3234,9 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the size of the locations array.' + 'description': ' Pass the number of bytes in the ViChar buffer you specify for the **NIRFSG_ATTR_TERMINAL_NAME** parameter.\n\n If you pass 0, you can pass VI_NULL for the **NIRFSG_ATTR_TERMINAL_NAME** parameter.\n ' }, - 'name': 'numberOfLocations', + 'name': 'bufferSize', 'type': 'ViInt32', 'use_array': False, 'use_in_python_api': True @@ -3244,35 +3244,27 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the marker locations stored in the NI-RFSG database for the channel you specified in the **NIRFSG_ATTR_CHANNEL_NAME** parameter. This value is expressed in samples.' + 'description': 'Returns the string to use as the source for other devices.' }, - 'name': 'locations', - 'type': 'ViReal64', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'out', - 'documentation': { - 'description': 'Returns the required size for the output array if you pass NULL to **Locations** parameter.' + 'name': 'terminalName', + 'size': { + 'mechanism': 'ivi-dance', + 'value': 'bufferSize' }, - 'name': 'requiredSize', - 'type': 'ViInt32', + 'type': 'ViChar[]', 'use_array': False, 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'InitWithOptions': { 'codegen_method': 'private', 'documentation': { - 'description': '\n Opens a session to the device you specify as the **NIRFSG_ATTR_RESOURCE_NAME** and returns a ViSession handle that you use to identify the NI-RFSG device in all subsequent NI-RFSG function calls. \n \n This function also configures the device through the **NIRFSG_ATTR_OPTION_STRING** input.\n\n **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Simulating an NI RF Signal Generator `_\n ', + 'description': '\n Opens a session to the device you specify as the NIRFSG_ATTR_RESOURCE_NAME and returns a ViSession handle that you use to identify the NI-RFSG device in all subsequent NI-RFSG function calls. \n \n This function also configures the device through the NIRFSG_ATTR_OPTION_STRING input.\n\n **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Simulating an NI RF Signal Generator `_\n ', 'note': 'For multichannel devices such as the PXIe-5860, the resource name must include the channel number to use. The channel number is specified by appending /*ChannelNumber* to the device name, where *ChannelNumber* is the channel number (0, 1, etc.). For example, if the device name is PXI1Slot2 and you want to use channel 0, use the resource name PXI1Slot2/0.' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_name_for_documentation': '__init__', 'method_templates': [ { @@ -3295,6 +3287,7 @@ 'use_in_python_api': True }, { + 'default_value': False, 'direction': 'in', 'documentation': { 'description': ' Specifies whether you want NI-RFSG to perform an ID query.\n\n **Defined Values** :\n ', @@ -3319,6 +3312,7 @@ 'use_in_python_api': True }, { + 'default_value': False, 'direction': 'in', 'documentation': { 'description': ' Specifies whether you want to reset the NI-RFSG device during the initialization procedure.\n\n **Defined Values** :\n\n ', @@ -3398,7 +3392,6 @@ 'description': ' \n\n Initiates signal generation, causing the NI-RFSG device to leave the Configuration state and enter the Generation state. \n \n If the settings have not been committed to the device before you call this function, they are committed by this function. The operation returns when the RF output signal settles. To return to the Configuration state, call the nirfsg_Abort function.\n\n **Supported Devices** : PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `NI-RFSG Instrument Driver Programming Flow `_\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'parameters': [ { 'direction': 'in', @@ -3411,8 +3404,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'LoadConfigurationsFromFile': { 'codegen_method': 'public', @@ -3420,7 +3412,6 @@ 'description': ' \n Loads the configurations from the specified file to the NI-RFSG driver session. \n \n The VI does an implicit reset before loading the configurations from the file.\n\n **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -3461,16 +3452,14 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'LockSession': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Obtains a multithread lock on the instrument session. \n \n Before doing so, this function waits until all other execution threads have released their locks on the instrument session.\n\n Other threads might have obtained a lock on this session in the following ways:\n\n - Your application already called the nirfsg_LockSession function.\n - A call to NI-RFSG locked the session.\n\n After the call to this function returns successfully, no other threads can access the instrument session until you call the nirfsg_UnlockSession function. Use the nirfsg_LockSession function and the nirfsg_UnlockSession function around a sequence of calls to NI-RFSG functions if you require that the NI-RFSG device retain its settings through the end of the sequence.\n\n You can safely make nested calls to the nirfsg_LockSession function within the same thread. To completely unlock the session, balance each call to the nirfsg_LockSession function with a call to the nirfsg_UnlockSession function. If, however, you use the **NIRFSG_ATTR_CALLER_HAS_LOCK** parameter in all calls to the nirfsg_LockSession function and the nirfsg_UnlockSession function within a function, the IVI Library locks the session only once within the function regardless of the number of calls you make to the nirfsg_LockSession function. Locking the session only once allows you to call nirfsg_UnlockSession just once at the end of the function.\n\n **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860\n ' + 'description': ' \n Obtains a multithread lock on the instrument session. \n \n Before doing so, this function waits until all other execution threads have released their locks on the instrument session.\n\n Other threads might have obtained a lock on this session in the following ways:\n\n - Your application already called the nirfsg_LockSession function.\n - A call to NI-RFSG locked the session.\n\n After the call to this function returns successfully, no other threads can access the instrument session until you call the nirfsg_UnlockSession function. Use the nirfsg_LockSession function and the nirfsg_UnlockSession function around a sequence of calls to NI-RFSG functions if you require that the NI-RFSG device retain its settings through the end of the sequence.\n\n You can safely make nested calls to the nirfsg_LockSession function within the same thread. To completely unlock the session, balance each call to the nirfsg_LockSession function with a call to the nirfsg_UnlockSession function. If, however, you use the NIRFSG_ATTR_CALLER_HAS_LOCK parameter in all calls to the nirfsg_LockSession function and the nirfsg_UnlockSession function within a function, the IVI Library locks the session only once within the function regardless of the number of calls you make to the nirfsg_LockSession function. Locking the session only once allows you to call nirfsg_UnlockSession just once at the end of the function.\n\n **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'lock', @@ -3513,7 +3502,6 @@ 'note': 'Power search temporarily enables the ALC, so ensure the appropriate included cable is connected between the PXIe-5654 ALCIN connector and the PXIe-5696 ALCOUT connector to successfully perform a power search.' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -3534,8 +3522,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'PerformThermalCorrection': { 'codegen_method': 'public', @@ -3543,7 +3530,6 @@ 'description': ' \n Corrects for any signal drift due to environmental temperature variation when generating the same signal for extended periods of time without a parameter change. \n \n Under normal circumstances of short-term signal generation, NI-RFSG performs thermal correction automatically by ensuring stable power levels, and you do not need to call this function.\n\n Use this function when generating the same signal for an extended period of time in a temperature-fluctuating environment. The NI-RFSG device must be in the Generation state before calling this function.\n\n **Supported Devices** : PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Thermal Management `_\n\n `Impairment Calibration `_\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -3564,8 +3550,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'QueryArbWaveformCapabilities': { 'codegen_method': 'public', @@ -3573,7 +3558,6 @@ 'description': ' \n Queries and returns the waveform capabilities of the NI-RFSG device. \n \n These capabilities are related to the current device configuration. The NI-RFSG device must be in the Configuration or the Generation state before calling this function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -3634,8 +3618,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ReadAndDownloadWaveformFromFileTDMS': { 'codegen_method': 'public', @@ -3643,7 +3626,6 @@ 'description': ' \n Reads the waveforms from a TDMS file and downloads one waveform into each of the NI RF vector signal generators.\n\n This function reads the following information from the TDMS file and writes it into the NI-RFSG session:\n\n - Sample Rate\n - PAPR\n - Runtime Scaling\n - RF Blanking Marker Locations\n - RF Blanking Enabled\n - Burst Start Locations\n - Burst Stop Locations\n - RF Blanking Marker Source\n - Signal Bandwidth\n - Waveform Size\n\n If RF blanking marker locations are present in the file but burst locations are not present, burst locations are calculated from RF blanking marker locations and stored in the NI-RFSG session.\n\n **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -3693,9 +3675,8 @@ 'use_array': False, 'use_in_python_api': True } - ], - 'returns': 'ViStatus', - 'use_session_lock': False + ], + 'returns': 'ViStatus' }, 'Reset': { 'codegen_method': 'public', @@ -3704,7 +3685,6 @@ 'note': 'This function resets all configured routes for the PXIe-5644/5645/5646 and PXIe-5820/5830/5831/5832/5840/5841/5842/5860 in NI-RFSA and NI-RFSG.' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -3725,8 +3705,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ResetAttribute': { 'codegen_method': 'public', @@ -3734,7 +3713,6 @@ 'description': ' \n\n Resets the attribute to its default value.\n\n **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -3775,8 +3753,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ResetDevice': { 'codegen_method': 'public', @@ -3785,7 +3762,6 @@ 'note': 'You must call the nirfsg_ResetDevice function if the NI-RFSG device has shut down because of a high-temperature condition.' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -3806,8 +3782,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'ResetWithDefaults': { 'codegen_method': 'public', @@ -3815,7 +3790,6 @@ 'description': '\n Performs a software reset of the device, returning it to the default state and applying any initial default settings from the IVI Configuration Store.\n\n **Supported Devices** : PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696,PXI-5670/5671, PXIe-5672/5673/5673E\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -3836,8 +3810,79 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' + }, + 'ResetWithOptions': { + 'codegen_method': 'public', + 'documentation': { + 'description': ' \n Resets all properties to default values and specifies steps to omit during the reset process, such as signal routes.\n\n By default, this function exhibits the same behavior as nirfsg_Reset. You can specify steps to omit using the steps to omit parameter. For example, if you specify NIRFSG_VAL_RESET_WITH_OPTIONS_ROUTES for the NIRFSG_ATTR_STEPS_TO_OMIT parameter, this function does not release signal routes during the reset process.\n\n When routes of signals between two devices are released, they are released regardless of which device created the route.\n\n To avoid resetting routes on PXIe-5820/5830/5831/5832/5840/5841/5842/5860 that are in use by NI-RFSA sessions, NI recommends using this function instead of nirfsg_Reset, with NIRFSG_ATTR_STEPS_TO_OMIT set to NIRFSG_VAL_RESET_WITH_OPTIONS_ROUTES.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Triggers `_\n\n `Events `_\n ' + }, + '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 list of steps to skip during the reset process. The default value is NIRFSG_VAL_RESET_WITH_OPTIONS_NONE, which specifies that no step is omitted during reset. **Defined Values** :', + 'note': 'NIRFSG_VAL_RESET_WITH_OPTIONS_ROUTES is not supported in external calibration or alignment sessions.', + 'table_body': [ + [ + 'NIRFSG_VAL_RESET_WITH_OPTIONS_NONE', + '0 (0x0)', + 'No step is omitted during reset.' + ], + [ + 'NIRFSG_VAL_RESET_WITH_OPTIONS_WAVEFORMS', + '1 (0x1)', + 'Omits clearing waveforms.' + ], + [ + 'NIRFSG_VAL_RESET_WITH_OPTIONS_SCRIPTS', + '2 (0x2)', + 'Omits clearing scripts.' + ], + [ + 'NIRFSG_VAL_RESET_WITH_OPTIONS_ROUTES', + '4 (0x4)', + 'Omits the routing reset step. Routing is preserved after a reset. However, routing related properties are reset to default, and routing is released if the default properties are committed after a reset.' + ], + [ + 'NIRFSG_VAL_RESET_WITH_OPTIONS_DEEMBEDDING_TABLES', + '8 (0x8)', + 'Omits deleting de-embedding tables. This step is valid only for the PXIe-5830/5831/5832/5840.' + ] + ], + 'table_header': [ + 'Name', + 'Value', + 'Description' + ] + }, + 'enum': 'ResetWithOptionsStepsToOmit', + 'name': 'stepsToOmit', + 'type': 'ViUInt64', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus' }, 'SaveConfigurationsToFile': { 'codegen_method': 'public', @@ -3845,7 +3890,6 @@ 'description': ' \n\n Saves the configurations of the session to the specified file.\n\n **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -3886,8 +3930,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'SelectArbWaveform': { 'codegen_method': 'public', @@ -3895,7 +3938,6 @@ 'description': ' \n\n Specifies the waveform that is generated upon a call to the nirfsg_Initiate function when the **generationMode** parameter of the nirfsg_ConfigureGenerationMode function is set to NIRFSG_VAL_ARB_WAVEFORM. \n \n You must specify a waveform using the NIRFSG_ATTR_NAME parameter if you have written multiple waveforms. The NI-RFSG device must be in the Configuration state before you call this function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Assigning Properties or Attributes to a Waveform `_\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -3926,8 +3968,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'SelfCal': { 'codegen_method': 'public', @@ -3936,7 +3977,6 @@ 'note': 'If there is an existing NI-RFSA session open for the same PXIe-5820/5830/5831/5832/5840/5841/5842/5860 while this function runs, it may remain open but cannot be used for operations that access the hardware, for example niRFSA_Commit or niRFSA_Initiate.' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -3957,8 +3997,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'SelfCalibrateRange': { 'codegen_method': 'public', @@ -3967,7 +4006,6 @@ 'note': '- This function does not update self-calibration date and temperature.\n\n - If there is an existing NI-RFSA session open for the same PXIe-5644/5645/5646, it may remain open but cannot be used while this function runs.\n\n - If there is an existing NI-RFSA session open for the same PXIe-5820/5830/5831/5832/5840/5841/5842 while this function runs, it may remain open but cannot be used for operations that access the hardware, for example niRFSA_Commit or niRFSA_Initiate.' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -4076,8 +4114,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'SelfTest': { 'codegen_method': 'public', @@ -4129,8 +4166,7 @@ 'type': 'ViChar[]' } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'SendSoftwareEdgeTrigger': { 'codegen_method': 'public', @@ -4138,7 +4174,6 @@ 'description': ' \n Forces a trigger to occur. \n \n The specified trigger generates regardless of whether the trigger has been configured as a software trigger.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Triggers `_\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -4189,41 +4224,34 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the Script Trigger to configure. This parameter is valid only when you set the NIRFSG_ATTR_TRIGGER parameter to NIRFSG_VAL_START_TRIGGER. Otherwise, set the **NIRFSG_ATTR_TRIGGER_IDENTIFIER** parameter to "" (empty string).\n\n **Default Value:** "" (empty string)\n\n **Defined Values:**\n ', + 'description': ' Specifies the Script Trigger to configure. This parameter is valid only when you set the NIRFSG_ATTR_TRIGGER parameter to NIRFSG_VAL_START_TRIGGER. Otherwise, set the NIRFSG_ATTR_TRIGGER_IDENTIFIER parameter to "" (empty string).\n\n **Default Value:** "" (empty string)\n\n **Possible Values:**\n ', 'table_body': [ [ - 'NIRFSG_VAL_SCRIPT_TRIGGER0', 'scriptTrigger0', 'Specifies Script Trigger 0.' ], [ - 'NIRFSG_VAL_SCRIPT_TRIGGER1', 'scriptTrigger1', 'Specifies Script Trigger 1.' ], [ - 'NIRFSG_VAL_SCRIPT_TRIGGER2', 'scriptTrigger2', 'Specifies Script Trigger 2.' ], [ - 'NIRFSG_VAL_SCRIPT_TRIGGER3', 'scriptTrigger3', 'Specifies Script Trigger 3.' ], [ - 'NIRFSG_VAL_NONE_EMPTY_STRING', '', 'None (no signal to export)' ] ], 'table_header': [ - 'Name', - 'Value', + 'Possible Value', 'Description' ] }, - 'enum': 'TriggerIdentifier', 'name': 'triggerIdentifier', 'type': 'ViConstString', 'use_array': False, @@ -4231,8 +4259,7 @@ } ], 'render_in_session_base': True, - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'SetArbWaveformNextWritePosition': { 'codegen_method': 'public', @@ -4241,7 +4268,6 @@ 'note': 'If you use this function to write the waveform that is currently generating, an undefined output may result.' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -4310,8 +4336,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'SetAttributeViBoolean': { 'codegen_method': 'private', @@ -4319,7 +4344,6 @@ 'description': ' \n\n Sets the value of a ViBoolean attribute.\n\n Use this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n - State caching is disabled for the entire session or for the particular attribute.\n - State caching is enabled, and the currently cached value is invalid or is different than the value you specify.\n\n NI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.\n\n Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -4371,8 +4395,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'SetAttributeViInt32': { 'codegen_method': 'private', @@ -4380,7 +4403,6 @@ 'description': '\n Sets the value of a ViInt32 attribute.\n\n Use this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n - State caching is disabled for the entire session or for the particular attribute.\n - State caching is enabled, and the currently cached value is invalid or is different than the value you specify.\n\n NI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.\n\n Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -4433,8 +4455,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'SetAttributeViInt64': { 'codegen_method': 'private', @@ -4442,7 +4463,6 @@ 'description': '\n Sets the value of a ViInt64 attribute.\n\n Use this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n - State caching is disabled for the entire session or for the particular attribute.\n - State caching is enabled, and the currently cached value is invalid or is different than the value you specify.\n\n NI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.\n\n Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -4494,8 +4514,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'SetAttributeViReal64': { 'codegen_method': 'private', @@ -4503,7 +4522,6 @@ 'description': ' \n Sets the value of a ViReal64 attribute.\n\n Use this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n - State caching is disabled for the entire session or for the particular attribute.\n - State caching is enabled, and the currently cached value is invalid or is different than the value you specify.\n\n NI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.\n\n Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -4556,8 +4574,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'SetAttributeViSession': { 'codegen_method': 'private', @@ -4565,7 +4582,6 @@ 'description': ' \n Sets the value of a ViSession attribute.\n\n Use this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n - State caching is disabled for the entire session or for the particular attribute.\n - State caching is enabled, and the currently cached value is invalid or is different than the value you specify.\n\n NI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.\n\n Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -4617,8 +4633,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'SetAttributeViString': { 'codegen_method': 'private', @@ -4626,7 +4641,6 @@ 'description': ' \n Sets the value of a ViString attribute.\n\n Use this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n - State caching is disabled for the entire session or for the particular attribute.\n - State caching is enabled, and the currently cached value is invalid or is different than the value you specify.\n\n NI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.\n\n Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -4679,188 +4693,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False - }, - 'SetWaveformBurstStartLocations': { - 'codegen_method': 'private', - 'documentation': { - 'description': ' \n Configures the start location of the burst in samples where the burst refers to the active portion of a waveform.\n\n **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842\n ' - }, - 'included_in_proto': True, - 'is_error_handling': False, - 'method_templates': [ - { - 'documentation_filename': 'default_method', - 'library_interpreter_filename': 'default_method', - 'method_python_name_suffix': '', - 'session_filename': 'default_method' - } - ], - 'parameters': [ - { - 'direction': 'in', - 'documentation': { - 'description': 'Identifies your instrument session. 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. Example: "waveform::waveform0/marker0"' - }, - 'name': 'channelName', - 'type': 'ViConstString', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Specifies the size of the burst start locations array.' - }, - 'name': 'numberOfLocations', - 'type': 'ViInt32', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'out', - 'documentation': { - 'description': 'Returns the burst start locations stored in the NI-RFSG session for the waveform that you specified in the **NIRFSG_ATTR_CHANNEL_NAME** parameter. This value is expressed in samples.' - }, - 'name': 'locations', - 'type': 'ViReal64', - 'use_array': False, - 'use_in_python_api': True - } - ], - 'returns': 'ViStatus', - 'use_session_lock': False - }, - 'SetWaveformBurstStopLocations': { - 'codegen_method': 'private', - 'documentation': { - 'description': ' \n\n Configures the stop location of the burst in samples where the burst refers to the active portion of a waveform.\n\n **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842\n ' - }, - 'included_in_proto': True, - 'is_error_handling': False, - 'method_templates': [ - { - 'documentation_filename': 'default_method', - 'library_interpreter_filename': 'default_method', - 'method_python_name_suffix': '', - 'session_filename': 'default_method' - } - ], - 'parameters': [ - { - 'direction': 'in', - 'documentation': { - 'description': 'Identifies your instrument session. 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\n Example:\n\n "waveform::waveform0/marker0"\n ' - }, - 'name': 'channelName', - 'type': 'ViConstString', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Specifies the size of the burst stop locations array.' - }, - 'name': 'numberOfLocations', - 'type': 'ViInt32', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'out', - 'documentation': { - 'description': 'Specifies the burst stop locations, in samples, to store in the NI-RFSG session.' - }, - 'name': 'locations', - 'type': 'ViReal64', - 'use_array': False, - 'use_in_python_api': True - } - ], - 'returns': 'ViStatus', - 'use_session_lock': False - }, - 'SetWaveformMarkerEventLocations': { - 'codegen_method': 'private', - 'documentation': { - 'description': ' \n\n Configures the marker locations associated with waveform and marker in the NI-RFSG session.\n\n **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842\n ' - }, - 'included_in_proto': True, - 'is_error_handling': False, - 'method_templates': [ - { - 'documentation_filename': 'default_method', - 'library_interpreter_filename': 'default_method', - 'method_python_name_suffix': '', - 'session_filename': 'default_method' - } - ], - 'parameters': [ - { - 'direction': 'in', - 'documentation': { - 'description': 'Identifies your instrument session. 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\n Example:\n\n "waveform::waveform0/marker0"\n ' - }, - 'name': 'channelName', - 'type': 'ViConstString', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Specifies the size of the locations array.' - }, - 'name': 'numberOfLocations', - 'type': 'ViInt32', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'out', - 'documentation': { - 'description': 'Specifies the marker location, in samples, to store in the NI-RFSG database.' - }, - 'name': 'locations', - 'type': 'ViReal64', - 'use_array': False, - 'use_in_python_api': True - } - ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'UnlockSession': { 'codegen_method': 'public', @@ -4868,7 +4701,6 @@ 'description': ' \n\n Releases a lock obtained on an NI-RFSG device session by calling the nirfsg_LockSession function.\n\n **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'unlock', @@ -4910,7 +4742,6 @@ 'description': '\n Waits until the RF output signal has settled. This function is useful for devices that support changes while in the Generation state. \n \n Call this function after making a dynamic change to wait for the output signal to settle.\n\n You can also call this function after calling the nirfsg_Commit function to wait for changes to settle. The nirfsg_WaitUntilSettled function is not required after calling the nirfsg_Initiate function because the nirfsg_Initiate automatically waits for the output to settle.\n\n **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -4941,8 +4772,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'WriteP2PEndpointI16': { 'codegen_method': 'public', @@ -4950,7 +4780,6 @@ 'description': ' \n\n Writes an array of 16-bit integer data to the peer-to-peer endpoint. \n \n Use this function to write initial data from the host to the endpoint before starting generation to avoid an underflow when you start the generation.\n\n **Supported Devices** : PXIe-5673E\n\n **Related Topics**\n\n `Peer-to-Peer Data Streaming `_--Refer to this topic for more information about configuring a stream.\n\n `Configuring Flow Control `_\n\n `Starting Peer-to-Peer Generation `_\n\n `Reconfiguring a Stream `_\n ' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -5005,8 +4834,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'WriteScript': { 'codegen_method': 'public', @@ -5015,7 +4843,6 @@ 'note': 'If you are using an RF vector signal transceiver (VST) device, some script instructions may not be supported.' }, 'included_in_proto': True, - 'is_error_handling': False, 'method_templates': [ { 'documentation_filename': 'default_method', @@ -5046,8 +4873,7 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'close': { 'codegen_method': 'private', @@ -5056,7 +4882,6 @@ }, 'grpc_name': 'Close', 'included_in_proto': True, - 'is_error_handling': False, 'parameters': [ { 'direction': 'in',