Skip to content

Commit 9efe042

Browse files
Vaishnavigupta1312Vaishnavigupta1312
authored
Adding nirfsg module with initial set of APIs (#2089)
* Supported generation of nirfsg module and added its metadata * Supported ViAttr and ViRsrc * Added nirfsg to build_release.py * Final auditing for public APIs * Resolved syntax warnings and self_test definition * Added rfsg generation commands * Enabled hightime functions for rfsg * Added basic system test for nirfsg * Modified CHANGELOG.md * Added basic nirfsg example * Corrected resource name in example * Removed system test for nirfsg * Removed example * Added example * Added system test for nirfsg * generated examples.rst * Updated tox.ini and tox-travis.ini with correct envlist * Removed nirfsg from workflow files * Addition of nirfsg to yaml files for running the system tests * Added enums related to functions * Related enums to functionas and renamed some enums * Fixed tox.ini and travis.ini * Updated the list to be alphabetical * Reverting the tooling changes * Reverted helper.py changes * Removed system test for nirfsg * Restructured nirfsg example * Modified nirfsg_usage.inc * Updated RFSG feed info * Updated rfsg module version * generated README.rst with updated vesion * Updated enum description and disabled session lock calls for rfsg * Updated README.rst * removing input() for non-interactive use of example * Removed print statement from example * Added documentation for functions * Added documentation for functions * Removing nirfsg out of action workflows * Updated CHANGELOG.md and modified documentation * Resolved review comments * Modified CHANGELOG.md * Modified CHANGELOG.md * Resolved comments * Updated latest nirfsg installer version * Reran codegen and updated generated files * Updated files
1 parent 8b52559 commit 9efe042

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+46805
-7
lines changed

‎CHANGELOG.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
- [nidmm (NI-DMM)](#nidmm-ni-dmm)
77
- [nifgen (NI-FGEN)](#nifgen-ni-fgen)
88
- [nimodinst (NI-ModInst)](#nimodinst-ni-modinst)
9+
- [nirfsg (NI-RFSG)](#nirfsg-ni-rfsg)
910
- [niscope (NI-SCOPE)](#niscope-ni-scope)
1011
- [nise (NI Switch Executive)](#nise-ni-switch-executive)
1112
- [niswitch (NI-SWITCH)](#niswitch-ni-switch)
@@ -1660,6 +1661,18 @@
16601661
- Initial release
16611662
---
16621663

1664+
### nirfsg (NI-RFSG)
1665+
1666+
- [Unreleased](#nirfsg-unreleased)
1667+
1668+
#### [nirfsg] Unreleased
1669+
- Added
1670+
- Enabled selected public APIs
1671+
- Basic example
1672+
- Documentation for APIs (not final)
1673+
- Changed
1674+
- Removed
1675+
16631676
### niscope (NI-SCOPE)
16641677

16651678
- [Unreleased](#niscope-unreleased)

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
This is the MIT license: http://www.opensource.org/licenses/mit-license.php
22

33
Copyright (c) 2017-2022, National Instruments Corporation.
4-
NI-Digital Pattern Driver, NI-DMM, NI-DCPower, NI-FGEN, NI-SCOPE, NI-SWITCH, NI Switch Executive,
4+
NI-Digital Pattern Driver, NI-DMM, NI-DCPower, NI-FGEN, NI-RFSG, NI-SCOPE, NI-SWITCH, NI Switch Executive,
55
NI-ModInst, NI-TClk are trademarks of National Instruments.
66

77
Permission is hereby granted, free of charge, to any person obtaining a copy of this

‎Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# In alphabetical order except put nifake first and nimodinst/nitclk last
22
# - nifake first to get the most code generator coverage
33
# - nimodinst last so that the version from nimodinst is used for any global versions (docs/conf.py)
4-
ALL_DRIVERS := nifake nidcpower nidigital nidmm nifgen niscope niswitch nise nimodinst nitclk
4+
ALL_DRIVERS := nifake nidcpower nidigital nidmm nifgen nirfsg niscope niswitch nise nimodinst nitclk
55
DRIVERS ?= $(ALL_DRIVERS)
66

77
ROOT_DIR := $(abspath .)

‎README.rst‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ following drivers are supported:
4646
* NI-DMM (Python module: nidmm)
4747
* NI-FGEN (Python module: nifgen)
4848
* NI-ModInst (Python module: nimodinst)
49+
* NI-RFSG (Python module: nirfsg)
4950
* NI-SCOPE (Python module: niscope)
5051
* NI Switch Executive (Python module: nise)
5152
* NI-SWITCH (Python module: niswitch)
@@ -291,6 +292,52 @@ NI-ModInst Python API Status
291292

292293

293294

295+
NI-RFSG Python API Status
296+
-------------------------
297+
298+
+-------------------------------+-----------------------+
299+
| NI-RFSG (nirfsg) | |
300+
+===============================+=======================+
301+
| Driver Version Tested Against | 2025 Q2 |
302+
+-------------------------------+-----------------------+
303+
| PyPI Version | |nirfsgLatestVersion| |
304+
+-------------------------------+-----------------------+
305+
| Supported Python Version | |nirfsgPythonVersion| |
306+
+-------------------------------+-----------------------+
307+
| Documentation | |nirfsgDocs| |
308+
+-------------------------------+-----------------------+
309+
| Open Issues | |nirfsgOpenIssues| |
310+
+-------------------------------+-----------------------+
311+
| Open Pull Requests | |nirfsgOpenPRs| |
312+
+-------------------------------+-----------------------+
313+
314+
315+
.. |nirfsgLatestVersion| image:: http://img.shields.io/pypi/v/nirfsg.svg
316+
:alt: Latest NI-RFSG Version
317+
:target: http://pypi.python.org/pypi/nirfsg
318+
319+
320+
.. |nirfsgPythonVersion| image:: http://img.shields.io/pypi/pyversions/nirfsg.svg
321+
:alt: NI-RFSG supported Python versions
322+
:target: http://pypi.python.org/pypi/nirfsg
323+
324+
325+
.. |nirfsgDocs| image:: https://readthedocs.org/projects/nirfsg/badge/?version=latest
326+
:alt: NI-RFSG Python API Documentation Status
327+
:target: https://nirfsg.readthedocs.io/en/latest
328+
329+
330+
.. |nirfsgOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/nirfsg.svg
331+
:alt: Open Issues + Pull Requests for NI-RFSG
332+
:target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Anirfsg
333+
334+
335+
.. |nirfsgOpenPRs| image:: https://img.shields.io/github/issues-pr/ni/nimi-python/nirfsg.svg
336+
:alt: Pull Requests for NI-RFSG
337+
:target: https://github.com/ni/nimi-python/pulls?q=is%3Aopen+is%3Aissue+label%3Anirfsg
338+
339+
340+
294341
NI-SCOPE Python API Status
295342
--------------------------
296343

@@ -486,6 +533,7 @@ Driver specific installation instructions can be found on **Read the Docs**:
486533
* `nidmm <https://nidmm.readthedocs.io/en/latest/nidmm.html#installation>`_
487534
* `nifgen <https://nifgen.readthedocs.io/en/latest/nifgen.html#installation>`_
488535
* `nimodinst <https://nimodinst.readthedocs.io/en/latest/nimodinst.html#installation>`_
536+
* `nirfsg <https://nirfsg.readthedocs.io/en/latest/nirfsg.html#installation>`_
489537
* `niscope <https://niscope.readthedocs.io/en/latest/niscope.html#installation>`_
490538
* `nise <https://nise.readthedocs.io/en/latest/nise.html#installation>`_
491539
* `niswitch <https://niswitch.readthedocs.io/en/latest/niswitch.html#installation>`_
@@ -543,12 +591,14 @@ Documentation is available on **Read the Docs**:
543591
- https://nidmm.readthedocs.io/en/stable
544592
- https://nifgen.readthedocs.io/en/stable
545593
- https://nimodinst.readthedocs.io/en/stable
594+
- https://nirfsg.readthedocs.io/en/stable
546595
- https://niscope.readthedocs.io/en/stable
547596
- https://nise.readthedocs.io/en/stable
548597
- https://niswitch.readthedocs.io/en/stable
549598
- https://nitclk.readthedocs.io/en/stable
550599

551600

601+
552602
.. _license-section:
553603

554604
License

‎build/templates/conf.py.mako‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ api_name = f"{config['driver_name']} Python API"
1010
api_name_no_spaces_or_hyphens = api_name.replace(" ", "").replace("-", "")
1111
api_name_no_spaces_or_hyphens_lower = api_name_no_spaces_or_hyphens.lower()
1212
13-
all_modules = {'nidcpower', 'nidigital', 'nidmm', 'nifgen', 'nimodinst', 'niscope', 'niswitch', 'nise', 'nitclk'}
13+
all_modules = {'nidcpower', 'nidigital', 'nidmm', 'nifgen', 'nimodinst', 'nirfsg', 'niscope', 'niswitch', 'nise', 'nitclk'}
1414
module_name = config['module_name']
1515
external_modules = all_modules - {module_name}
1616
%>\

‎build/templates/index.rst.mako‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
doc_header = f"{config['driver_name']} Python API Documentation"
44
module_name = config['module_name']
55
driver_name = config['driver_name']
6+
mi_drivers = ['nidcpower', 'nidigital', 'nidmm', 'nifgen', 'nimodinst', 'niscope', 'niswitch', 'nise', 'nitclk']
7+
read_the_docs_note = (
8+
"Refer to the `nimi-python Read the Docs project <https://nimi-python.readthedocs.io/en/stable/>`_ for documentation of versions 1.4.4 of the module or earlier."
9+
)
610
%>\
711

812
${doc_header}
@@ -25,7 +29,9 @@ Additional Documentation
2529

2630
Refer to your driver documentation for device-specific information and detailed API documentation.
2731

28-
Refer to the `nimi-python Read the Docs project <https://nimi-python.readthedocs.io/en/stable/>`_ for documentation of versions 1.4.4 of the module or earlier.
32+
% if module_name in mi_drivers:
33+
${read_the_docs_note}
34+
% endif
2935

3036
.. include:: ../_static/license.inc
3137

‎docs/_static/about.inc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ following drivers are supported:
1111
* NI-DMM (Python module: nidmm)
1212
* NI-FGEN (Python module: nifgen)
1313
* NI-ModInst (Python module: nimodinst)
14+
* NI-RFSG (Python module: nirfsg)
1415
* NI-SCOPE (Python module: niscope)
1516
* NI Switch Executive (Python module: nise)
1617
* NI-SWITCH (Python module: niswitch)

‎docs/_static/documentation.inc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,11 @@ Documentation is available on **Read the Docs**:
1010
- https://nidmm.readthedocs.io/en/stable
1111
- https://nifgen.readthedocs.io/en/stable
1212
- https://nimodinst.readthedocs.io/en/stable
13+
- https://nirfsg.readthedocs.io/en/stable
1314
- https://niscope.readthedocs.io/en/stable
1415
- https://nise.readthedocs.io/en/stable
1516
- https://niswitch.readthedocs.io/en/stable
1617
- https://nitclk.readthedocs.io/en/stable
1718

1819

20+

‎docs/_static/installation.inc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Driver specific installation instructions can be found on **Read the Docs**:
1010
* `nidmm <https://nidmm.readthedocs.io/en/latest/nidmm.html#installation>`_
1111
* `nifgen <https://nifgen.readthedocs.io/en/latest/nifgen.html#installation>`_
1212
* `nimodinst <https://nimodinst.readthedocs.io/en/latest/nimodinst.html#installation>`_
13+
* `nirfsg <https://nirfsg.readthedocs.io/en/latest/nirfsg.html#installation>`_
1314
* `niscope <https://niscope.readthedocs.io/en/latest/niscope.html#installation>`_
1415
* `nise <https://nise.readthedocs.io/en/latest/nise.html#installation>`_
1516
* `niswitch <https://niswitch.readthedocs.io/en/latest/niswitch.html#installation>`_

‎docs/_static/nirfsg_documentation.inc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.. _documentation-section:
2+
3+
Documentation
4+
=============
5+
6+
Documentation is available `here <http://nirfsg.readthedocs.io>`_.
7+
8+

0 commit comments

Comments
 (0)