Skip to content

datatype updates to a few nirfsg properties #2147

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 1 commit into from
Dec 9, 2025
+112 −253
Merged

datatype updates to a few nirfsg properties #2147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1696,6 +1696,9 @@
- Changed the name of `get_self_calibration_last_date_and_time` to `get_self_cal_last_date_and_time` to be consistent with other MI drivers
- Added default value for `module` parameter in `get_self_cal_last_date_and_time` and `get_self_calibration_temperature` methods to align with documentation and allow duck-typing
- Updated `self_test` to not have any parameters, aligning with other MI drivers
- Changed `frequency_settling` property to be of type float instead of hightime.timedelta, since it can have multiple interpretation based on `frequency_settling_units` property value
- Changed `interpolation_delay` and `relative_delay` properties to be of type hightime.timedelta, so that it aligns with _delay_ attributes across all drivers
- 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
- Removed
- Methods and properties applicable only to hardware which are not supported anymore
- Methods
Expand Down
134 changes: 65 additions & 69 deletions docs/nirfsg/class.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5325,35 +5325,33 @@ exported_ref_clock_rate

Specifies the Reference Clock Rate, in Hz, of the signal sent to the Reference Clock Export Output Terminal. To set this property, the NI-RFSG device must be in the Configuration state.

**Default Value:** :py:data:`~nirfsg.ReferenceClockExportedRate.CLOCK_RATE_10_MEGAHERTZ`
**Default Value:** 10MHz

**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860

**Defined Values**:

+------------------------------------------------------------------------+--------------+-------------------------------------+
| Name | Value | Description |
+========================================================================+==============+=====================================+
| :py:data:`~nirfsg.ReferenceClockExportedRate.CLOCK_RATE_10_MEGAHERTZ` | 10000000.0 | Uses a 10MHz Reference Clock rate. |
+------------------------------------------------------------------------+--------------+-------------------------------------+
| :py:data:`~nirfsg.ReferenceClockExportedRate.CLOCK_RATE_100_MEGAHERTZ` | 100000000.0 | Uses a 100MHz Reference Clock rate. |
+------------------------------------------------------------------------+--------------+-------------------------------------+
| :py:data:`~nirfsg.ReferenceClockExportedRate.CLOCK_RATE_1_GIGAHERTZ` | 1000000000.0 | Uses a 1GHz Reference Clock rate. |
+------------------------------------------------------------------------+--------------+-------------------------------------+

.. 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.
+--------------+-------------------------------------+
| Value | Description |
+==============+=====================================+
| 10000000.0 | Uses a 10MHz Reference Clock rate. |
+--------------+-------------------------------------+
| 100000000.0 | Uses a 100MHz Reference Clock rate. |
+--------------+-------------------------------------+
| 1000000000.0 | Uses a 1GHz Reference Clock rate. |
+--------------+-------------------------------------+

The following table lists the characteristics of this property.

+-----------------------+----------------------------------+
| Characteristic | Value |
+=======================+==================================+
| Datatype | enums.ReferenceClockExportedRate |
+-----------------------+----------------------------------+
| Permissions | read-write |
+-----------------------+----------------------------------+
| Repeated Capabilities | None |
+-----------------------+----------------------------------+
+-----------------------+------------+
| Characteristic | Value |
+=======================+============+
| Datatype | float |
+-----------------------+------------+
| Permissions | read-write |
+-----------------------+------------+
| Repeated Capabilities | None |
+-----------------------+------------+

.. tip::
This property corresponds to the following LabVIEW Property or C Attribute:
Expand Down Expand Up @@ -5972,15 +5970,15 @@ frequency_settling

The following table lists the characteristics of this property.

+-----------------------+-------------------------------------------------------------+
| Characteristic | Value |
+=======================+=============================================================+
| Datatype | hightime.timedelta, datetime.timedelta, or float in seconds |
+-----------------------+-------------------------------------------------------------+
| Permissions | read-write |
+-----------------------+-------------------------------------------------------------+
| Repeated Capabilities | None |
+-----------------------+-------------------------------------------------------------+
+-----------------------+------------+
| Characteristic | Value |
+=======================+============+
| Datatype | float |
+-----------------------+------------+
| Permissions | read-write |
+-----------------------+------------+
| Repeated Capabilities | None |
+-----------------------+------------+

.. tip::
This property corresponds to the following LabVIEW Property or C Attribute:
Expand Down Expand Up @@ -6246,15 +6244,15 @@ interpolation_delay

The following table lists the characteristics of this property.

+-----------------------+------------+
| Characteristic | Value |
+=======================+============+
| Datatype | float |
+-----------------------+------------+
| Permissions | read-write |
+-----------------------+------------+
| Repeated Capabilities | None |
+-----------------------+------------+
+-----------------------+-------------------------------------------------------------+
| Characteristic | Value |
+=======================+=============================================================+
| Datatype | hightime.timedelta, datetime.timedelta, or float in seconds |
+-----------------------+-------------------------------------------------------------+
| Permissions | read-write |
+-----------------------+-------------------------------------------------------------+
| Repeated Capabilities | None |
+-----------------------+-------------------------------------------------------------+

.. tip::
This property corresponds to the following LabVIEW Property or C Attribute:
Expand Down Expand Up @@ -8665,11 +8663,11 @@ ref_clock_rate

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.

If you set this property to :py:data:`~nirfsg.ReferenceClockRate.AUTO`, NI-RFSG uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if automatic detection is supported by the device.
If you set this property to Auto, NI-RFSG uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if automatic detection is supported by the device.

**Valid Values:**

PXIe-5654/5654 with PXIe-5696: Values between 1MHz to 20MHz in 1MHz steps are supported in addition to the :py:data:`~nirfsg.ReferenceClockRate.AUTO` and :py:data:`~nirfsg.ReferenceClockRate.CLOCK_RATE_10_MEGAHERTZ` values.
PXIe-5654/5654 with PXIe-5696: Values between 1MHz to 20MHz in 1MHz steps are supported in addition to the Auto and 10MHz values.

PXIe-5841 with PXIe-5655, PXIe-5842: 10 MHz, 100 MHz, 270 MHz, and 3.84 MHz

Expand All @@ -8681,7 +8679,7 @@ ref_clock_rate

**Units**: hertz (Hz)

**Default Value:** :py:data:`~nirfsg.ReferenceClockRate.AUTO`
**Default Value:** Auto

**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

Expand All @@ -8695,29 +8693,27 @@ ref_clock_rate

**Defined Values**:

+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| Value | Description |
+===============================================================+===================================================================================================================================+
| :py:data:`~nirfsg.ReferenceClockRate.AUTO` | Uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if the device supports it. |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :py:data:`~nirfsg.ReferenceClockRate.CLOCK_RATE_10_MEGAHERTZ` | Uses a 10 MHz Reference Clock rate. |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
+-------+------------+-----------------------------------------------------------------------------------------------------------------------------------+
| Name | Value | Description |
+=======+============+===================================================================================================================================+
| Auto | -1.0 | Uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if the device supports it. |
+-------+------------+-----------------------------------------------------------------------------------------------------------------------------------+
| 10MHz | 10000000.0 | Uses a 10 MHz Reference Clock rate. |
+-------+------------+-----------------------------------------------------------------------------------------------------------------------------------+

.. note:: Automatic detection of the Reference Clock rate is supported on only the PXIe-5654/5654 with PXIe-5696. For all other supported devices, NI-RFSG uses the default Reference Clock rate of 10MHz.

.. 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.ReferenceClockRate |
+-----------------------+--------------------------+
| Permissions | read-write |
+-----------------------+--------------------------+
| Repeated Capabilities | None |
+-----------------------+--------------------------+
+-----------------------+------------+
| Characteristic | Value |
+=======================+============+
| Datatype | float |
+-----------------------+------------+
| Permissions | read-write |
+-----------------------+------------+
| Repeated Capabilities | None |
+-----------------------+------------+

.. tip::
This property corresponds to the following LabVIEW Property or C Attribute:
Expand Down Expand Up @@ -8860,15 +8856,15 @@ relative_delay

The following table lists the characteristics of this property.

+-----------------------+------------+
| Characteristic | Value |
+=======================+============+
| Datatype | float |
+-----------------------+------------+
| Permissions | read-write |
+-----------------------+------------+
| Repeated Capabilities | None |
+-----------------------+------------+
+-----------------------+-------------------------------------------------------------+
| Characteristic | Value |
+=======================+=============================================================+
| Datatype | hightime.timedelta, datetime.timedelta, or float in seconds |
+-----------------------+-------------------------------------------------------------+
| Permissions | read-write |
+-----------------------+-------------------------------------------------------------+
| Repeated Capabilities | None |
+-----------------------+-------------------------------------------------------------+

.. tip::
This property corresponds to the following LabVIEW Property or C Attribute:
Expand Down
60 changes: 0 additions & 60 deletions docs/nirfsg/enums.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1036,66 +1036,6 @@ RFInLoExportEnabled



ReferenceClockExportedRate
--------------------------

.. py:class:: ReferenceClockExportedRate

.. py:attribute:: ReferenceClockExportedRate.CLOCK_RATE_10_MEGAHERTZ



Uses a 10MHz Reference Clock rate.





.. py:attribute:: ReferenceClockExportedRate.CLOCK_RATE_100_MEGAHERTZ



Uses a 100MHz Reference Clock rate.





.. py:attribute:: ReferenceClockExportedRate.CLOCK_RATE_1_GIGAHERTZ



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.CLOCK_RATE_10_MEGAHERTZ



Uses a 10MHz Reference Clock rate.





ReferencePllBandwidth
---------------------

Expand Down
26 changes: 0 additions & 26 deletions generated/nirfsg/nirfsg/enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -451,32 +451,6 @@ class RFInLoExportEnabled(Enum):
'''


class ReferenceClockExportedRate(Enum):
CLOCK_RATE_10_MEGAHERTZ = 10000000
r'''
Uses a 10MHz Reference Clock rate.
'''
CLOCK_RATE_100_MEGAHERTZ = 100000000.0
r'''
Uses a 100MHz Reference Clock rate.
'''
CLOCK_RATE_1_GIGAHERTZ = 1000000000.0
r'''
Uses a 1GHz Reference Clock rate.
'''


class ReferenceClockRate(Enum):
AUTO = -1
r'''
Uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if the device supports it.
'''
CLOCK_RATE_10_MEGAHERTZ = 10000000
r'''
Uses a 10MHz Reference Clock rate.
'''


class ReferencePllBandwidth(Enum):
NARROW = 0
r'''
Expand Down
Loading