Skip to main content
Info Contains Python APIs for interacting with RFmx Demod Product.
Author National Instruments

Table of Contents

About

The nirfmx-python repository generates Python bindings (Application Programming Interface) for interacting with the RFmx Products.

nirfmx-python follows Python Software Foundation support policy for different versions.

RFmx Instr Python API Status

Item Details
Driver Version Tested 2026 Q4
Supported Python Versions Python 3.9+ (64-bit)
Documentation RFmx Instr Docs

RFmx Demod Python API Status

Item Details
Driver Version Tested 2026 Q4
Supported Python Versions Python 3.9+ (64-bit)
Documentation RFmx Demod Docs

Documentation

You can find the latest API documentation for the nirfmx-python package on Read the Docs

Refer to the RFmx User Manual for an overview of RFmx, system requirements, troubleshooting, key concepts, etc.

Operating System Support

nirfmx-python supports Windows systems where the supported drivers are installed. Refer to NI Hardware and Operating System Compatibility for which versions of the driver support your hardware on a given operating system.

Installation

You can use pip to download nirfmxdemod and install it.

$ python -m pip install nirfmxdemod

To also install gRPC support for remote NI gRPC Device Server communication:

$ python -m pip install "nirfmxdemod[grpc]"

Upgrade

You can use pip to upgrade nirfmxdemod package using following command:

$ python -m pip install nirfmxdemod --upgrade

License

This project is licensed under the MIT License. While the source code is not publicly released, the license permits binary distribution with attribution.

Note: This Python driver depends on several third-party components that are subject to separate commercial licenses. Users are responsible for ensuring they have the appropriate rights and licenses to use those dependencies in their environments.

gRPC Features

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

SSL/TLS Support

The server supports both server-side TLS and mutual TLS. Security configuration is accomplished by setting the server_cert, server_key and root_cert values in the server's configuration file. The server expects the certificate files specified in the configuration file to exist in a certs folder that is located in the same directory as the configuration file being used by the server. For more detailed information on SSL/TLS support refer to the Server Security Support wiki page.

Support and Feedback

For support with Python API, hardware, the driver runtime or any other questions, please visit NI Community Forums.

RFmx Demod Example

import nirfmxinstr
import nirfmxdemod

instr_session = None
demod = None

try:
    # Create a new RFmx Session
    instr_session = nirfmxinstr.Session(resource_name="RFSA", option_string="")

    # Get Demod signal
    demod = instr_session.get_demod_signal_configuration()

    # Configure measurement
    demod.set_selected_ports(selector_string="", value="")
    demod.configure_rf(
        selector_string="", center_frequency=1e9, 
        reference_level=0.00, external_attenuation=0.00
    )
    demod.analog_demod.configuration.configure_rbw_filter(
        selector_string="", rbw=100e3, 
        rbw_filter_type=nirfmxdemod.ADemodRbwFilterType.FLAT,
        rbw_rrc_alpha=0.1
    )
    demod.analog_demod.configuration.configure_measurement_interval(
        selector_string="", 
        measurement_interval=10e-3
    )
    demod.analog_demod.configuration.configure_am_carrier_suppressed(
        selector_string="", 
        am_carrier_suppressed_enabled=nirfmxdemod.ADemodAMCarrierSuppressedEnabled.FALSE
    )
    demod.analog_demod.configuration.configure_averaging(
        selector_string="", averaging_enabled=nirfmxdemod.ADemodAveragingEnabled.FALSE, averaging_count=10, averaging_type=nirfmxdemod.ADemodAveragingType.LINEAR
    )

    # Retrieve results
    mean_modulation_depth, mean_carrier_power, error_code = 
        demod.analog_demod.results.read_am(
            selector_string="", timeout=10.0
        )

    # Print Results
    print(f"Mean Modulation Depth (%)        {mean_modulation_depth}")
    print(f"Mean Carrier Power   (dBm)       {mean_carrier_power}")

except Exception as e:
    print("ERROR: " + str(e))

finally:
    # Dispose Signal & Session
    if demod is not None:
        demod.dispose()
        demod = None
    if instr_session is not None:
        instr_session.close()
        instr_session = None

Numpy array size handling in RFmx APIs

The numpy arrays are passed in pre-allocated. If the pre allocated array size does not match the actual array size returned by the measurement, the array is automatically resized to fit the data, which may invalidate the previously created view. Passing an empty array (size 0) is fine; it will be resized as needed.

Metadata

Release files for nirfmxdemod 26.8.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for nirfmxdemod 26.8.0
File Interpreter ABI Platform Actions
nirfmxdemod-26.8.0-py3-none-any.whl Python 3 none any Details for nirfmxdemod-26.8.0-py3-none-any.whl

Release files / nirfmxdemod-26.8.0-py3-none-any.whl

Download URL nirfmxdemod-26.8.0-py3-none-any.whl
Size 158.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
53fe1c74cf7b6c3b082e68d3b4ffaf0beb3512ec79216f4e2635f017fc2f54fe
BLAKE2b-256 checksum
How to use checksums
73643ab9444d2ffa5bb8342da893d3eb96fa2de9238dfb02471c840f8abde9e4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 19, 2026.

Transparency log

Security for nirfmxdemod 26.8.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

1 file in this release has been uploaded with provenance metadata.

Attestation for nirfmxdemod-26.8.0-py3-none-any.whl

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 19, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page