nirfsg 1.0.1

NI-RFSG Python API

Overall Status

master branch status
GitHub status

Info	NI Modular Instrument driver APIs for Python.
Author	NI

About

The nirfsg module provides a Python API for NI-RFSG. The code is maintained in the Open Source repository for nimi-python.

Support Policy

nirfsg supports all the Operating Systems supported by NI-RFSG.

It follows Python Software Foundation support policy for different versions of CPython.

NI created and supports nirfsg.

NI-RFSG Python API Status

NI-RFSG (nirfsg)
Driver Version Tested Against	2025 Q3
PyPI Version
Supported Python Version
Documentation
Open Issues
Open Pull Requests

Installation

As a prerequisite to using the nirfsg module, you must install the NI-RFSG runtime on your system. Visit ni.com/downloads to download the driver runtime for your devices.

The nimi-python modules (i.e. for NI-RFSG) can be installed with pip:

$ python -m pip install nirfsg~=1.0.1

Contributing

We welcome contributions! You can clone the project repository, build it, and install it by following these instructions.

Usage

The following is a basic example of using the nirfsg module to open a session to an RF Signal Generator and generate a continuous wave (CW) signal.

import nirfsg

# Configure the session
with nirfsg.Session(resource_name='5841', id_query=False, reset_device=False, options='Simulate=1, DriverSetup=Model:5841') as session:
    # Configure RF settings
    session.configure_rf(
        frequency=1e9,  # Frequency in Hz
        power_level=-10.0  # Power level in dBm
    )
    session.generation_mode = nirfsg.GenerationMode.CW

    # Start signal generation
    with session.initiate():
        input("Press Enter to stop generation")

Other usage examples can be found on GitHub... _support-section:

Support / Feedback

For support specific to the Python API, follow the processs in Bugs / Feature Requests. For support with hardware, the driver runtime or any other questions not specific to the Python API, please visit NI Community Forums.

Bugs / Feature Requests

To report a bug or submit a feature request specific to Python API, please use the GitHub issues page.

Fill in the issue template as completely as possible and we will respond as soon as we can.

Documentation

Documentation is available here.

License

nimi-python is licensed under an MIT-style license (see LICENSE). Other incorporated projects may be licensed under different licenses. All licenses allow for non-commercial and commercial use.

gRPC Features

For driver APIs that support it, passing a GrpcSessionOptions instance as a parameter to Session.__init__() is subject to the NI General Purpose EULA (see NILICENSE).