Skip to content

Adding ni-rfsa to repository #2193

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
Aug 14, 2026
+57 −3
Merged

Adding ni-rfsa to repository #2193

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
069eca4
documentation related changes
mohit-emerson Aug 13, 2026
3eaacf9
README, License etc
mohit-emerson Aug 13, 2026
a7791f9
review comments addressed
mohit-emerson Aug 14, 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
10 changes: 10 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
- [nidmm (NI-DMM)](#nidmm-ni-dmm)
- [nifgen (NI-FGEN)](#nifgen-ni-fgen)
- [nimodinst (NI-ModInst)](#nimodinst-ni-modinst)
- [nirfsa (NI-RFSA)](#nirfsa-ni-rfsa)
- [nirfsg (NI-RFSG)](#nirfsg-ni-rfsg)
- [niscope (NI-SCOPE)](#niscope-ni-scope)
- [nise (NI Switch Executive)](#nise-ni-switch-executive)
Expand Down Expand Up @@ -1724,6 +1725,15 @@
- Initial release
---

### nirfsa (NI-RFSA)

- [Unreleased](#nirfsa-unreleased)

#### [nirfsa] Unreleased
- Added
- Changed
- Removed

### nirfsg (NI-RFSG)

- [Unreleased](#nirfsg-unreleased)
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
This is the MIT license: http://www.opensource.org/licenses/mit-license.php

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

Permission is hereby granted, free of charge, to any person obtaining a copy of this
Expand Down
2 changes: 2 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -533,6 +533,7 @@ Driver specific installation instructions can be found on **Read the Docs**:
* `nidmm <https://nidmm.readthedocs.io/en/latest/nidmm.html#installation>`_
* `nifgen <https://nifgen.readthedocs.io/en/latest/nifgen.html#installation>`_
* `nimodinst <https://nimodinst.readthedocs.io/en/latest/nimodinst.html#installation>`_
* `nirfsa <https://nirfsa.readthedocs.io/en/latest/nirfsa.html#installation>`_
* `nirfsg <https://nirfsg.readthedocs.io/en/latest/nirfsg.html#installation>`_
* `niscope <https://niscope.readthedocs.io/en/latest/niscope.html#installation>`_
* `nise <https://nise.readthedocs.io/en/latest/nise.html#installation>`_
Expand Down Expand Up @@ -591,6 +592,7 @@ Documentation is available on **Read the Docs**:
- https://nidmm.readthedocs.io
- https://nifgen.readthedocs.io
- https://nimodinst.readthedocs.io
- https://nirfsa.readthedocs.io
- https://nirfsg.readthedocs.io
- https://niscope.readthedocs.io
- https://nise.readthedocs.io
Expand Down
2 changes: 1 addition & 1 deletion build/templates/conf.py.mako
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ api_name = f"{config['driver_name']} Python API"
api_name_no_spaces_or_hyphens = api_name.replace(" ", "").replace("-", "")
api_name_no_spaces_or_hyphens_lower = api_name_no_spaces_or_hyphens.lower()

all_modules = {'nidcpower', 'nidigital', 'nidmm', 'nifgen', 'nimodinst', 'nirfsg', 'niscope', 'niswitch', 'nise', 'nitclk'}
all_modules = {'nidcpower', 'nidigital', 'nidmm', 'nifgen', 'nimodinst', 'nirfsa', 'nirfsg', 'niscope', 'niswitch', 'nise', 'nitclk'}
module_name = config['module_name']
external_modules = all_modules - {module_name}
%>\
Expand Down
1 change: 1 addition & 0 deletions docs/_static/documentation.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Documentation is available on **Read the Docs**:
- https://nidmm.readthedocs.io
- https://nifgen.readthedocs.io
- https://nimodinst.readthedocs.io
- https://nirfsa.readthedocs.io
- https://nirfsg.readthedocs.io
- https://niscope.readthedocs.io
- https://nise.readthedocs.io
Expand Down
1 change: 1 addition & 0 deletions docs/_static/installation.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Driver specific installation instructions can be found on **Read the Docs**:
* `nidmm <https://nidmm.readthedocs.io/en/latest/nidmm.html#installation>`_
* `nifgen <https://nifgen.readthedocs.io/en/latest/nifgen.html#installation>`_
* `nimodinst <https://nimodinst.readthedocs.io/en/latest/nimodinst.html#installation>`_
* `nirfsa <https://nirfsa.readthedocs.io/en/latest/nirfsa.html#installation>`_
* `nirfsg <https://nirfsg.readthedocs.io/en/latest/nirfsg.html#installation>`_
* `niscope <https://niscope.readthedocs.io/en/latest/niscope.html#installation>`_
* `nise <https://nise.readthedocs.io/en/latest/nise.html#installation>`_
Expand Down
8 changes: 8 additions & 0 deletions docs/_static/nirfsa_documentation.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _documentation-section:

Documentation
=============

Documentation is available `here <http://nirfsa.readthedocs.io>`_.


22 changes: 22 additions & 0 deletions docs/_static/nirfsa_usage.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Usage
------

The following is a basic example of using the **nirfsa** module to open a session to an RF Signal Analyzer and perform a spectrum acquisition.

.. code-block:: python

import nirfsa

# Configure the session
with nirfsa.Session(resource_name='5841', id_query=False, reset_device=False, options='Simulate=1, DriverSetup=Model:5841') as rfsa_session:
rfsa_session.acquisition_type = nirfsa.AcquisitionType.IQ

rfsa_session.reference_level = -10
rfsa_session.iq_carrier_frequency = 1e9

iq_data_array = np.zeros(1024, dtype=np.complex128)

wfm_info = rfsa_session.read_iq_single_record_into(iq_data_array)
# Perform measurements...

`Other usage examples can be found on GitHub. <https://github.com/ni/nimi-python/tree/master/src/nirfsa/examples>`_
1 change: 1 addition & 0 deletions docs/nidcpower/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,7 @@ def setup(app):
'nidmm': ('https://nidmm.readthedocs.io/en/latest/', None),
'nifgen': ('https://nifgen.readthedocs.io/en/latest/', None),
'nimodinst': ('https://nimodinst.readthedocs.io/en/latest/', None),
'nirfsa': ('https://nirfsa.readthedocs.io/en/latest/', None),
'nirfsg': ('https://nirfsg.readthedocs.io/en/latest/', None),
'niscope': ('https://niscope.readthedocs.io/en/latest/', None),
'nise': ('https://nise.readthedocs.io/en/latest/', None),
Expand Down
1 change: 1 addition & 0 deletions docs/nidigital/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,7 @@ def setup(app):
'nidmm': ('https://nidmm.readthedocs.io/en/latest/', None),
'nifgen': ('https://nifgen.readthedocs.io/en/latest/', None),
'nimodinst': ('https://nimodinst.readthedocs.io/en/latest/', None),
'nirfsa': ('https://nirfsa.readthedocs.io/en/latest/', None),
'nirfsg': ('https://nirfsg.readthedocs.io/en/latest/', None),
'niscope': ('https://niscope.readthedocs.io/en/latest/', None),
'nise': ('https://nise.readthedocs.io/en/latest/', None),
Expand Down
1 change: 1 addition & 0 deletions docs/nidmm/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,7 @@ def setup(app):
'nidigital': ('https://nidigital.readthedocs.io/en/latest/', None),
'nifgen': ('https://nifgen.readthedocs.io/en/latest/', None),
'nimodinst': ('https://nimodinst.readthedocs.io/en/latest/', None),
'nirfsa': ('https://nirfsa.readthedocs.io/en/latest/', None),
'nirfsg': ('https://nirfsg.readthedocs.io/en/latest/', None),
'niscope': ('https://niscope.readthedocs.io/en/latest/', None),
'nise': ('https://nise.readthedocs.io/en/latest/', None),
Expand Down
1 change: 1 addition & 0 deletions docs/nifgen/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,7 @@ def setup(app):
'nidigital': ('https://nidigital.readthedocs.io/en/latest/', None),
'nidmm': ('https://nidmm.readthedocs.io/en/latest/', None),
'nimodinst': ('https://nimodinst.readthedocs.io/en/latest/', None),
'nirfsa': ('https://nirfsa.readthedocs.io/en/latest/', None),
'nirfsg': ('https://nirfsg.readthedocs.io/en/latest/', None),
'niscope': ('https://niscope.readthedocs.io/en/latest/', None),
'nise': ('https://nise.readthedocs.io/en/latest/', None),
Expand Down
1 change: 1 addition & 0 deletions docs/nimodinst/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,7 @@ def setup(app):
'nidigital': ('https://nidigital.readthedocs.io/en/latest/', None),
'nidmm': ('https://nidmm.readthedocs.io/en/latest/', None),
'nifgen': ('https://nifgen.readthedocs.io/en/latest/', None),
'nirfsa': ('https://nirfsa.readthedocs.io/en/latest/', None),
'nirfsg': ('https://nirfsg.readthedocs.io/en/latest/', None),
'niscope': ('https://niscope.readthedocs.io/en/latest/', None),
'nise': ('https://nise.readthedocs.io/en/latest/', None),
Expand Down
1 change: 1 addition & 0 deletions docs/nirfsg/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@ def setup(app):
'nidmm': ('https://nidmm.readthedocs.io/en/latest/', None),
'nifgen': ('https://nifgen.readthedocs.io/en/latest/', None),
'nimodinst': ('https://nimodinst.readthedocs.io/en/latest/', None),
'nirfsa': ('https://nirfsa.readthedocs.io/en/latest/', None),
'niscope': ('https://niscope.readthedocs.io/en/latest/', None),
'nise': ('https://nise.readthedocs.io/en/latest/', None),
'niswitch': ('https://niswitch.readthedocs.io/en/latest/', None),
Expand Down
1 change: 1 addition & 0 deletions docs/niscope/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@ def setup(app):
'nidmm': ('https://nidmm.readthedocs.io/en/latest/', None),
'nifgen': ('https://nifgen.readthedocs.io/en/latest/', None),
'nimodinst': ('https://nimodinst.readthedocs.io/en/latest/', None),
'nirfsa': ('https://nirfsa.readthedocs.io/en/latest/', None),
'nirfsg': ('https://nirfsg.readthedocs.io/en/latest/', None),
'nise': ('https://nise.readthedocs.io/en/latest/', None),
'niswitch': ('https://niswitch.readthedocs.io/en/latest/', None),
Expand Down
1 change: 1 addition & 0 deletions docs/nise/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@ def setup(app):
'nidmm': ('https://nidmm.readthedocs.io/en/latest/', None),
'nifgen': ('https://nifgen.readthedocs.io/en/latest/', None),
'nimodinst': ('https://nimodinst.readthedocs.io/en/latest/', None),
'nirfsa': ('https://nirfsa.readthedocs.io/en/latest/', None),
'nirfsg': ('https://nirfsg.readthedocs.io/en/latest/', None),
'niscope': ('https://niscope.readthedocs.io/en/latest/', None),
'niswitch': ('https://niswitch.readthedocs.io/en/latest/', None),
Expand Down
1 change: 1 addition & 0 deletions docs/niswitch/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@ def setup(app):
'nidmm': ('https://nidmm.readthedocs.io/en/latest/', None),
'nifgen': ('https://nifgen.readthedocs.io/en/latest/', None),
'nimodinst': ('https://nimodinst.readthedocs.io/en/latest/', None),
'nirfsa': ('https://nirfsa.readthedocs.io/en/latest/', None),
'nirfsg': ('https://nirfsg.readthedocs.io/en/latest/', None),
'niscope': ('https://niscope.readthedocs.io/en/latest/', None),
'nise': ('https://nise.readthedocs.io/en/latest/', None),
Expand Down
1 change: 1 addition & 0 deletions docs/nitclk/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@ def setup(app):
'nidmm': ('https://nidmm.readthedocs.io/en/latest/', None),
'nifgen': ('https://nifgen.readthedocs.io/en/latest/', None),
'nimodinst': ('https://nimodinst.readthedocs.io/en/latest/', None),
'nirfsa': ('https://nirfsa.readthedocs.io/en/latest/', None),
'nirfsg': ('https://nirfsg.readthedocs.io/en/latest/', None),
'niscope': ('https://niscope.readthedocs.io/en/latest/', None),
'nise': ('https://nise.readthedocs.io/en/latest/', None),
Expand Down
2 changes: 1 addition & 1 deletion generated/nifake/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
This is the MIT license: http://www.opensource.org/licenses/mit-license.php

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

Permission is hereby granted, free of charge, to any person obtaining a copy of this
Expand Down
Loading