Skip to content

Add string enums for applicable attributes and method parameters in nirfsg #2150

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 5 commits into from
Dec 17, 2025
Merged

Add string enums for applicable attributes and method parameters in nirfsg #2150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
24a13ca
adding back string enums in src
vnktshr21 Dec 17, 2025
e557619
Merge branch 'master' of https://github.com/vnktshr21/nimi-python int…
vnktshr21 Dec 17, 2025
09285e1
added all changes after integration
vnktshr21 Dec 17, 2025
cfd3019
changed to properties
vnktshr21 Dec 17, 2025
374e0e3
sorted changelog
vnktshr21 Dec 17, 2025
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
16 changes: 12 additions & 4 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1691,17 +1691,25 @@
#### [nirfsg] Unreleased
- Added
- Changed
- Fixed the return type of `get_all_script_names` and `get_all_named_waveform_names` to remove the size parameter and return a list of strings instead of a comma-separated string
- 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
- Changed the parameter name for waveform name from `name` to `waveform_name` in `clear_arb_waveform` and `select_arb_waveform` to be consistent with other waveform methods
- Changed the name of below methods to be consistent with other APIs in the repository
- `get_self_calibration_last_date_and_time` to `get_self_cal_last_date_and_time`
- `get_external_calibration_last_date_and_time` to `get_ext_cal_last_date_and_time`
- 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 APIs in the repository
- 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 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
- 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 `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
- `pulse_modulation_source`
- `exported_pulse_modulation_event_output_terminal`
- `exported_ref_clock_output_terminal`
- `lo_source`
- `arb_sample_clock_source`
- `ref_clock_source`
- `trigger_identifier` parameter in `send_software_edge_trigger` method
- Removed
- Methods and properties applicable only to hardware which are not supported anymore
- Methods
Expand Down
110 changes: 55 additions & 55 deletions docs/nirfsg/class.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2310,7 +2310,7 @@ send_software_edge_trigger
.. 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: str
:type trigger_identifier: :py:data:`nirfsg.TriggerIdentifier`

set_arb_waveform_next_write_position
------------------------------------
Expand Down Expand Up @@ -3460,15 +3460,15 @@ arb_sample_clock_source

The following table lists the characteristics of this property.

+-----------------------+------------+
| Characteristic | Value |
+=======================+============+
| Datatype | str |
+-----------------------+------------+
| Permissions | read-write |
+-----------------------+------------+
| Repeated Capabilities | None |
+-----------------------+------------+
+-----------------------+----------------------------+
| Characteristic | Value |
+=======================+============================+
| Datatype | enums.ArbSampleClockSource |
+-----------------------+----------------------------+
| Permissions | read-write |
+-----------------------+----------------------------+
| Repeated Capabilities | None |
+-----------------------+----------------------------+

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

The following table lists the characteristics of this property.

+-----------------------+------------+
| Characteristic | Value |
+=======================+============+
| Datatype | str |
+-----------------------+------------+
| Permissions | read-write |
+-----------------------+------------+
| Repeated Capabilities | None |
+-----------------------+------------+
+-----------------------+-------------------------------------+
| Characteristic | Value |
+=======================+=====================================+
| Datatype | enums.PulseModulationOutputTerminal |
+-----------------------+-------------------------------------+
| Permissions | read-write |
+-----------------------+-------------------------------------+
| Repeated Capabilities | None |
+-----------------------+-------------------------------------+

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

The following table lists the characteristics of this property.

+-----------------------+------------+
| Characteristic | Value |
+=======================+============+
| Datatype | str |
+-----------------------+------------+
| Permissions | read-write |
+-----------------------+------------+
| Repeated Capabilities | None |
+-----------------------+------------+
+-----------------------+------------------------------------------+
| Characteristic | Value |
+=======================+==========================================+
| Datatype | enums.ReferenceClockExportOutputTerminal |
+-----------------------+------------------------------------------+
| Permissions | read-write |
+-----------------------+------------------------------------------+
| Repeated Capabilities | None |
+-----------------------+------------------------------------------+

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

The following table lists the characteristics of this property.

+-----------------------+------------+
| Characteristic | Value |
+=======================+============+
| Datatype | str |
+-----------------------+------------+
| Permissions | read-write |
+-----------------------+------------+
| Repeated Capabilities | los |
+-----------------------+------------+
+-----------------------+----------------+
| Characteristic | Value |
+=======================+================+
| Datatype | enums.LoSource |
+-----------------------+----------------+
| Permissions | read-write |
+-----------------------+----------------+
| Repeated Capabilities | los |
+-----------------------+----------------+

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

The following table lists the characteristics of this property.

+-----------------------+------------+
| Characteristic | Value |
+=======================+============+
| Datatype | str |
+-----------------------+------------+
| Permissions | read-write |
+-----------------------+------------+
| Repeated Capabilities | None |
+-----------------------+------------+
+-----------------------+-----------------------------+
| Characteristic | Value |
+=======================+=============================+
| Datatype | enums.PulseModulationSource |
+-----------------------+-----------------------------+
| Permissions | read-write |
+-----------------------+-----------------------------+
| Repeated Capabilities | None |
+-----------------------+-----------------------------+

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

The following table lists the characteristics of this property.

+-----------------------+------------+
| Characteristic | Value |
+=======================+============+
| Datatype | str |
+-----------------------+------------+
| Permissions | read-write |
+-----------------------+------------+
| Repeated Capabilities | None |
+-----------------------+------------+
+-----------------------+----------------------------+
| Characteristic | Value |
+=======================+============================+
| Datatype | enums.ReferenceClockSource |
+-----------------------+----------------------------+
| Permissions | read-write |
+-----------------------+----------------------------+
| Repeated Capabilities | None |
+-----------------------+----------------------------+

.. tip::
This property corresponds to the following LabVIEW Property or C Attribute:
Expand Down
Loading