Skip to content

nirfsg: Synchronize API updates with latest driver #2188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vnktshr21 merged 3 commits into from
Jul 28, 2026
Merged

nirfsg: Synchronize API updates with latest driver #2188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3b5f872
changelog updated
mohit-emerson Jul 28, 2026
12d50d6
codegen with latest 26.8.0d95 exports rfsg
mohit-emerson Jul 28, 2026
ffe5b58
review comments addressed
mohit-emerson Jul 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1702,6 +1702,7 @@

#### [nirfsg] Unreleased
- Added
- `AMPLITUDE_FLATNESS` and `AMPLITUDE_AND_PHASE_FLATNESS` added to enum `DeembeddingType`
Comment thread
mohit-emerson marked this conversation as resolved.
- Changed
- Removed

Expand Down
30 changes: 18 additions & 12 deletions docs/nirfsg/class.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4179,27 +4179,33 @@ 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.DeembeddingType.SCALAR` or :py:data:`~nirfsg.DeembeddingType.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 any value besides :py:data:`~nirfsg.DeembeddingType.NONE`, 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.DeembeddingType.SCALAR`

**Valid Values for PXIe-5830/5832/5840/5841/5842/5860** : :py:data:`~nirfsg.DeembeddingType.SCALAR` or :py:data:`~nirfsg.DeembeddingType.NONE`
**Valid Values for PXIe-5830/5832/5840/5841** : :py:data:`~nirfsg.DeembeddingType.NONE` or :py:data:`~nirfsg.DeembeddingType.SCALAR`

**Valid Values for PXIe-5831** :py:data:`~nirfsg.DeembeddingType.SCALAR`, :py:data:`~nirfsg.DeembeddingType.VECTOR`, or :py:data:`~nirfsg.DeembeddingType.NONE`. :py:data:`~nirfsg.DeembeddingType.VECTOR` is only supported for TRX Ports in a Semiconductor Test System (STS).
**Valid Values for PXIe-5842/5860** : :py:data:`~nirfsg.DeembeddingType.NONE` or :py:data:`~nirfsg.DeembeddingType.SCALAR` or :py:data:`~nirfsg.DeembeddingType.AMPLITUDE_FLATNESS` or :py:data:`~nirfsg.DeembeddingType.AMPLITUDE_AND_PHASE_FLATNESS`

**Valid Values for PXIe-5831** :py:data:`~nirfsg.DeembeddingType.NONE`, :py:data:`~nirfsg.DeembeddingType.SCALAR`, or :py:data:`~nirfsg.DeembeddingType.VECTOR`. :py:data:`~nirfsg.DeembeddingType.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.DeembeddingType.NONE` | 25000 (0x61a8) | De-embedding is not applied to the measurement. |
+-------------------------------------------+----------------+------------------------------------------------------------------------+
| :py:data:`~nirfsg.DeembeddingType.SCALAR` | 25001 (0x61a9) | De-embeds the measurement using only the gain term. |
+-------------------------------------------+----------------+------------------------------------------------------------------------+
| :py:data:`~nirfsg.DeembeddingType.VECTOR` | 25002 (0x61aa) | De-embeds the measurement using the gain term and the reflection term. |
+-------------------------------------------+----------------+------------------------------------------------------------------------+
+-----------------------------------------------------------------+----------------+-----------------------------------------------------------------------------------+
| Name | Value | Description |
+=================================================================+================+===================================================================================+
| :py:data:`~nirfsg.DeembeddingType.NONE` | 25000 (0x61a8) | De-embedding is not applied to the measurement. |
+-----------------------------------------------------------------+----------------+-----------------------------------------------------------------------------------+
| :py:data:`~nirfsg.DeembeddingType.SCALAR` | 25001 (0x61a9) | De-embeds the measurement using only the gain term. |
+-----------------------------------------------------------------+----------------+-----------------------------------------------------------------------------------+
| :py:data:`~nirfsg.DeembeddingType.VECTOR` | 25002 (0x61aa) | De-embeds the measurement using the gain term and the reflection term. |
+-----------------------------------------------------------------+----------------+-----------------------------------------------------------------------------------+
| :py:data:`~nirfsg.DeembeddingType.AMPLITUDE_FLATNESS` | 25003 (0x61ab) | De-embeds the measurement using wideband amplitude flatness correction. |
+-----------------------------------------------------------------+----------------+-----------------------------------------------------------------------------------+
| :py:data:`~nirfsg.DeembeddingType.AMPLITUDE_AND_PHASE_FLATNESS` | 25004 (0x61ac) | De-embeds the measurement using wideband amplitude and phase flatness correction. |
+-----------------------------------------------------------------+----------------+-----------------------------------------------------------------------------------+


.. tip:: This property can be set/get on specific ports within your :py:class:`nirfsg.Session` instance.
Expand Down
20 changes: 20 additions & 0 deletions docs/nirfsg/enums.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,6 +346,26 @@ DeembeddingType



.. py:attribute:: DeembeddingType.AMPLITUDE_FLATNESS
De-embeds the measurement using wideband amplitude flatness correction.





.. py:attribute:: DeembeddingType.AMPLITUDE_AND_PHASE_FLATNESS
De-embeds the measurement using wideband amplitude and phase flatness correction.





DigitalEqualizationEnabled
--------------------------

Expand Down
8 changes: 8 additions & 0 deletions generated/nirfsg/nirfsg/enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,14 @@ class DeembeddingType(Enum):
r'''
De-embeds the measurement using the gain term and the reflection term.
'''
AMPLITUDE_FLATNESS = 25003
r'''
De-embeds the measurement using wideband amplitude flatness correction.
'''
AMPLITUDE_AND_PHASE_FLATNESS = 25004
r'''
De-embeds the measurement using wideband amplitude and phase flatness correction.
'''


class DigitalEqualizationEnabled(Enum):
Expand Down
30 changes: 18 additions & 12 deletions generated/nirfsg/nirfsg/session.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -822,27 +822,33 @@ 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 DeembeddingType.SCALAR or DeembeddingType.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 any value besides DeembeddingType.NONE, 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**: DeembeddingType.SCALAR

**Valid Values for PXIe-5830/5832/5840/5841/5842/5860** : DeembeddingType.SCALAR or DeembeddingType.NONE
**Valid Values for PXIe-5830/5832/5840/5841** : DeembeddingType.NONE or DeembeddingType.SCALAR

**Valid Values for PXIe-5831** DeembeddingType.SCALAR, DeembeddingType.VECTOR, or DeembeddingType.NONE. DeembeddingType.VECTOR is only supported for TRX Ports in a Semiconductor Test System (STS).
**Valid Values for PXIe-5842/5860** : DeembeddingType.NONE or DeembeddingType.SCALAR or DeembeddingType.AMPLITUDE_FLATNESS or DeembeddingType.AMPLITUDE_AND_PHASE_FLATNESS

**Valid Values for PXIe-5831** DeembeddingType.NONE, DeembeddingType.SCALAR, or DeembeddingType.VECTOR. DeembeddingType.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 |
+========================+================+========================================================================+
| DeembeddingType.NONE | 25000 (0x61a8) | De-embedding is not applied to the measurement. |
+------------------------+----------------+------------------------------------------------------------------------+
| DeembeddingType.SCALAR | 25001 (0x61a9) | De-embeds the measurement using only the gain term. |
+------------------------+----------------+------------------------------------------------------------------------+
| DeembeddingType.VECTOR | 25002 (0x61aa) | De-embeds the measurement using the gain term and the reflection term. |
+------------------------+----------------+------------------------------------------------------------------------+
+----------------------------------------------+----------------+-----------------------------------------------------------------------------------+
| Name | Value | Description |
+==============================================+================+===================================================================================+
| DeembeddingType.NONE | 25000 (0x61a8) | De-embedding is not applied to the measurement. |
+----------------------------------------------+----------------+-----------------------------------------------------------------------------------+
| DeembeddingType.SCALAR | 25001 (0x61a9) | De-embeds the measurement using only the gain term. |
+----------------------------------------------+----------------+-----------------------------------------------------------------------------------+
| DeembeddingType.VECTOR | 25002 (0x61aa) | De-embeds the measurement using the gain term and the reflection term. |
+----------------------------------------------+----------------+-----------------------------------------------------------------------------------+
| DeembeddingType.AMPLITUDE_FLATNESS | 25003 (0x61ab) | De-embeds the measurement using wideband amplitude flatness correction. |
+----------------------------------------------+----------------+-----------------------------------------------------------------------------------+
| DeembeddingType.AMPLITUDE_AND_PHASE_FLATNESS | 25004 (0x61ac) | De-embeds the measurement using wideband amplitude and phase flatness correction. |
+----------------------------------------------+----------------+-----------------------------------------------------------------------------------+

Tip:
This property can be set/get on specific ports within your :py:class:`nirfsg.Session` instance.
Expand Down
12 changes: 11 additions & 1 deletion src/nirfsg/metadata/attributes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3360,7 +3360,7 @@
'access': 'read-write',
'codegen_method': 'public',
'documentation': {
'description': 'Specifies the type of de-embedding to apply to measurements on the specified port.\n\nTo use this attribute, you must use the channelName parameter of the nirfsg_SetAttributeViInt32 function to specify the name of the port to configure for de-embedding.\n\nIf you set this attribute to NIRFSG_VAL_DEEMBEDDING_TYPE_SCALAR or NIRFSG_VAL_DEEMBEDDING_TYPE_VECTOR, NI-RFSG adjusts the instrument settings and the returned data to remove the effects of the external network between the instrument and the DUT.\n\n**Default Value**: NIRFSG_VAL_DEEMBEDDING_TYPE_SCALAR\n\n**Valid Values for PXIe-5830/5832/5840/5841/5842/5860** : NIRFSG_VAL_DEEMBEDDING_TYPE_SCALAR or NIRFSG_VAL_DEEMBEDDING_TYPE_NONE\n\n**Valid Values for PXIe-5831** NIRFSG_VAL_DEEMBEDDING_TYPE_SCALAR, NIRFSG_VAL_DEEMBEDDING_TYPE_VECTOR, or NIRFSG_VAL_DEEMBEDDING_TYPE_NONE. NIRFSG_VAL_DEEMBEDDING_TYPE_VECTOR is only supported for TRX Ports in a Semiconductor Test System (STS).\n\n**Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:',
'description': 'Specifies the type of de-embedding to apply to measurements on the specified port.\n\nTo use this attribute, you must use the channelName parameter of the nirfsg_SetAttributeViInt32 function to specify the name of the port to configure for de-embedding.\n\nIf you set this attribute to any value besides NIRFSG_VAL_DEEMBEDDING_TYPE_NONE, NI-RFSG adjusts the instrument settings and the returned data to remove the effects of the external network between the instrument and the DUT.\n\n**Default Value**: NIRFSG_VAL_DEEMBEDDING_TYPE_SCALAR\n\n**Valid Values for PXIe-5830/5832/5840/5841** : NIRFSG_VAL_DEEMBEDDING_TYPE_NONE or NIRFSG_VAL_DEEMBEDDING_TYPE_SCALAR\n\n**Valid Values for PXIe-5842/5860** : NIRFSG_VAL_DEEMBEDDING_TYPE_NONE or NIRFSG_VAL_DEEMBEDDING_TYPE_SCALAR or NIRFSG_VAL_DEEMBEDDING_TYPE_AMPLITUDE_FLATNESS or NIRFSG_VAL_DEEMBEDDING_TYPE_AMPLITUDE_AND_PHASE_FLATNESS\n\n**Valid Values for PXIe-5831** NIRFSG_VAL_DEEMBEDDING_TYPE_NONE, NIRFSG_VAL_DEEMBEDDING_TYPE_SCALAR, or NIRFSG_VAL_DEEMBEDDING_TYPE_VECTOR. NIRFSG_VAL_DEEMBEDDING_TYPE_VECTOR is only supported for TRX Ports in a Semiconductor Test System (STS).\n\n**Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:',
'table_body': [
[
'NIRFSG_VAL_DEEMBEDDING_TYPE_NONE',
Expand All @@ -3376,6 +3376,16 @@
'NIRFSG_VAL_DEEMBEDDING_TYPE_VECTOR',
'25002 (0x61aa)',
'De-embeds the measurement using the gain term and the reflection term.'
],
[
'NIRFSG_VAL_DEEMBEDDING_TYPE_AMPLITUDE_FLATNESS',
'25003 (0x61ab)',
'De-embeds the measurement using wideband amplitude flatness correction.'
],
[
'NIRFSG_VAL_DEEMBEDDING_TYPE_AMPLITUDE_AND_PHASE_FLATNESS',
'25004 (0x61ac)',
'De-embeds the measurement using wideband amplitude and phase flatness correction.'
]
],
'table_header': [
Expand Down
14 changes: 14 additions & 0 deletions src/nirfsg/metadata/enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,20 @@
},
'name': 'NIRFSG_VAL_DEEMBEDDING_TYPE_VECTOR',
'value': 25002
},
{
'documentation': {
'description': 'De-embeds the measurement using wideband amplitude flatness correction.'
},
'name': 'NIRFSG_VAL_DEEMBEDDING_TYPE_AMPLITUDE_FLATNESS',
'value': 25003
},
{
'documentation': {
'description': 'De-embeds the measurement using wideband amplitude and phase flatness correction.'
},
'name': 'NIRFSG_VAL_DEEMBEDDING_TYPE_AMPLITUDE_AND_PHASE_FLATNESS',
'value': 25004
}
]
},
Expand Down
Loading