Skip to content

Updated few nirfsg properties to have string and interval datatypes consistent with other APIs in repository #2152

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
ni-jfitzger merged 4 commits into from
Jan 7, 2026
Merged

Updated few nirfsg properties to have string and interval datatypes consistent with other APIs in repository #2152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
91a659c
using new attribute classes
vnktshr21 Jan 5, 2026
046a5f8
updated changelog
vnktshr21 Jan 5, 2026
5cbdcfe
fixes from review comments
vnktshr21 Jan 6, 2026
e9ea4f3
Merge branch 'master' of https://github.com/vnktshr21/nimi-python int…
vnktshr21 Jan 7, 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
7 changes: 7 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1705,6 +1705,7 @@
- Changed `interpolation_delay` and `relative_delay` properties to be of type hightime.timedelta, so that it aligns with _delay_ attributes across other APIs in the repository
- Changed `exported_ref_clock_rate` and `ref_clock_rate` properties to be of type float instead of enum, since the enums just represented raw float values
- Fixed the return type of `get_all_script_names` and `get_all_named_waveform_names` to remove the size parameter and return a list of strings instead of a comma-separated string
- Updated `external_calibration_recommended_interval` property to return a hightime.timedelta object instead of months as an int, aligning with other APIs in the repository
- Updated `self_test` to not have any parameters, aligning with other APIs in the repository
- Updated `wait_until_settled` method to have `max_time_milliseconds` parameter as type hightime.timedelta with a default value of 10 seconds
- Updated below properties and method parameters to be of string enum type instead of plain string, since they would support only fixed set of strings
Expand All @@ -1715,6 +1716,12 @@
- `arb_sample_clock_source`
- `ref_clock_source`
- `trigger_identifier` parameter in `send_software_edge_trigger` method
- Updated below properties to be list of str instead of them returning a comma separated list of string values
- `available_paths`
- `available_ports`
- `fixed_group_delay_across_ports`
- `group_capabilities`
- `supported_instrument_models`
- Removed
- Python 3.9 Support
- Methods and properties applicable only to hardware which are not supported anymore
Expand Down
120 changes: 59 additions & 61 deletions docs/nirfsg/class.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3888,19 +3888,19 @@ available_paths

.. py:attribute:: available_paths

Returns a comma separated list of the configurable paths available for use based on your instrument configuration.
Returns a list of the configurable paths available for use based on your instrument configuration.

The following table lists the characteristics of this property.

+-----------------------+-----------+
| Characteristic | Value |
+=======================+===========+
| Datatype | str |
+-----------------------+-----------+
| Permissions | read only |
+-----------------------+-----------+
| Repeated Capabilities | None |
+-----------------------+-----------+
+-----------------------+-------------+
| Characteristic | Value |
+=======================+=============+
| Datatype | list of str |
+-----------------------+-------------+
| Permissions | read only |
+-----------------------+-------------+
| Repeated Capabilities | None |
+-----------------------+-------------+

.. tip::
This property corresponds to the following LabVIEW Property or C Attribute:
Expand All @@ -3913,21 +3913,21 @@ available_ports

.. py:attribute:: available_ports

Returns a comma-separated list of the ports available for use based on your instrument configuration.
Returns a list of the ports available for use based on your instrument configuration.

**Supported Devices**: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860

The following table lists the characteristics of this property.

+-----------------------+-----------+
| Characteristic | Value |
+=======================+===========+
| Datatype | str |
+-----------------------+-----------+
| Permissions | read only |
+-----------------------+-----------+
| Repeated Capabilities | None |
+-----------------------+-----------+
+-----------------------+-------------+
| Characteristic | Value |
+=======================+=============+
| Datatype | list of str |
+-----------------------+-------------+
| Permissions | read only |
+-----------------------+-------------+
| Repeated Capabilities | None |
+-----------------------+-------------+

.. tip::
This property corresponds to the following LabVIEW Property or C Attribute:
Expand Down Expand Up @@ -5629,21 +5629,19 @@ external_calibration_recommended_interval

Returns the recommended interval between each external calibration of the device.

**Units**: months

**Supported Devices:** PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860

The following table lists the characteristics of this property.

+-----------------------+-----------+
| Characteristic | Value |
+=======================+===========+
| Datatype | int |
+-----------------------+-----------+
| Permissions | read only |
+-----------------------+-----------+
| Repeated Capabilities | None |
+-----------------------+-----------+
+-----------------------+--------------------+
| Characteristic | Value |
+=======================+====================+
| Datatype | hightime.timedelta |
+-----------------------+--------------------+
| Permissions | read only |
+-----------------------+--------------------+
| Repeated Capabilities | None |
+-----------------------+--------------------+

.. tip::
This property corresponds to the following LabVIEW Property or C Attribute:
Expand Down Expand Up @@ -5765,22 +5763,22 @@ fixed_group_delay_across_ports

.. py:attribute:: fixed_group_delay_across_ports

Specifies a comma-separated list of ports for which to fix the group delay.
Specifies a list of ports for which to fix the group delay.


**Supported Devices:** PXIe-5831/5832

The following table lists the characteristics of this property.

+-----------------------+------------+
| Characteristic | Value |
+=======================+============+
| Datatype | str |
+-----------------------+------------+
| Permissions | read-write |
+-----------------------+------------+
| Repeated Capabilities | None |
+-----------------------+------------+
+-----------------------+-------------+
| Characteristic | Value |
+=======================+=============+
| Datatype | list of str |
+-----------------------+-------------+
| Permissions | read-write |
+-----------------------+-------------+
| Repeated Capabilities | None |
+-----------------------+-------------+

.. tip::
This property corresponds to the following LabVIEW Property or C Attribute:
Expand Down Expand Up @@ -6093,21 +6091,21 @@ group_capabilities

.. py:attribute:: group_capabilities

Returns a string that contains a comma-separated list of class-extension groups that NI-RFSG implements.
Returns a list of class-extension groups that NI-RFSG implements.

**Supported Devices:** PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860

The following table lists the characteristics of this property.

+-----------------------+-----------+
| Characteristic | Value |
+=======================+===========+
| Datatype | str |
+-----------------------+-----------+
| Permissions | read only |
+-----------------------+-----------+
| Repeated Capabilities | None |
+-----------------------+-----------+
+-----------------------+-------------+
| Characteristic | Value |
+=======================+=============+
| Datatype | list of str |
+-----------------------+-------------+
| Permissions | read only |
+-----------------------+-------------+
| Repeated Capabilities | None |
+-----------------------+-------------+

.. tip::
This property corresponds to the following LabVIEW Property or C Attribute:
Expand Down Expand Up @@ -9792,21 +9790,21 @@ supported_instrument_models

.. py:attribute:: supported_instrument_models

Returns a string that contains a model code of the NI-RFSG device. For drivers that support more than one device, this property contains a comma-separated list of supported devices.
Returns a list of supported devices.

**Supported Devices:** PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860

The following table lists the characteristics of this property.

+-----------------------+-----------+
| Characteristic | Value |
+=======================+===========+
| Datatype | str |
+-----------------------+-----------+
| Permissions | read only |
+-----------------------+-----------+
| Repeated Capabilities | None |
+-----------------------+-----------+
+-----------------------+-------------+
| Characteristic | Value |
+=======================+=============+
| Datatype | list of str |
+-----------------------+-------------+
| Permissions | read only |
+-----------------------+-------------+
| Repeated Capabilities | None |
+-----------------------+-------------+

.. tip::
This property corresponds to the following LabVIEW Property or C Attribute:
Expand Down
36 changes: 17 additions & 19 deletions generated/nirfsg/nirfsg/session.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -727,15 +727,15 @@ class _SessionBase(object):
Note:
One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.
'''
available_paths = _attributes.AttributeViString(1150312)
'''Type: str
available_paths = _attributes.AttributeViStringCommaSeparated(1150312)
'''Type: list of str

Returns a comma separated list of the configurable paths available for use based on your instrument configuration.
Returns a list of the configurable paths available for use based on your instrument configuration.
'''
available_ports = _attributes.AttributeViString(1150249)
'''Type: str
available_ports = _attributes.AttributeViStringCommaSeparated(1150249)
'''Type: list of str

Returns a comma-separated list of the ports available for use based on your instrument configuration.
Returns a list of the ports available for use based on your instrument configuration.

**Supported Devices**: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860
'''
Expand Down Expand Up @@ -1882,13 +1882,11 @@ class _SessionBase(object):
| "DIO/PFI7" | The trigger is received on PFI7 from the front panel DIO terminal. |
+----------------+----------------------------------------------------------------------------------------------------------------------------------------+
'''
external_calibration_recommended_interval = _attributes.AttributeViInt32(1150076)
'''Type: int
external_calibration_recommended_interval = _attributes.AttributeViInt32TimeDeltaMonths(1150076)
'''Type: hightime.timedelta

Returns the recommended interval between each external calibration of the device.

**Units**: months

**Supported Devices:** PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860
'''
external_calibration_temperature = _attributes.AttributeViReal64(1150077)
Expand Down Expand Up @@ -1938,10 +1936,10 @@ class _SessionBase(object):
| False | The RF signal generator has the 1 ms tuning option. |
+-------+------------------------------------------------------------+
'''
fixed_group_delay_across_ports = _attributes.AttributeViString(1150271)
'''Type: str
fixed_group_delay_across_ports = _attributes.AttributeViStringCommaSeparated(1150271)
'''Type: list of str

Specifies a comma-separated list of ports for which to fix the group delay.
Specifies a list of ports for which to fix the group delay.


**Supported Devices:** PXIe-5831/5832
Expand Down Expand Up @@ -2103,10 +2101,10 @@ class _SessionBase(object):
| GenerationMode.SCRIPT | 1002 (0x3ea) | Configures the RF signal generator to generate arbitrary waveforms as directed by the selected_script property.. |
+-----------------------------+--------------+------------------------------------------------------------------------------------------------------------------------+
'''
group_capabilities = _attributes.AttributeViString(1050401)
'''Type: str
group_capabilities = _attributes.AttributeViStringCommaSeparated(1050401)
'''Type: list of str

Returns a string that contains a comma-separated list of class-extension groups that NI-RFSG implements.
Returns a list of class-extension groups that NI-RFSG implements.

**Supported Devices:** PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860
'''
Expand Down Expand Up @@ -4098,10 +4096,10 @@ class _SessionBase(object):

`Streaming Waveform Data <https://www.ni.com/docs/en-US/bundle/rfsg/page/rfsg/streaming_waveform_data.html>`_
'''
supported_instrument_models = _attributes.AttributeViString(1050327)
'''Type: str
supported_instrument_models = _attributes.AttributeViStringCommaSeparated(1050327)
'''Type: list of str

Returns a string that contains a model code of the NI-RFSG device. For drivers that support more than one device, this property contains a comma-separated list of supported devices.
Returns a list of supported devices.

**Supported Devices:** PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860
'''
Expand Down
Loading