Metadata-Version: 2.4
Name: nirfmxwlangen
Version: 26.3.0
Summary: Python APIs for interacting with RFmx WLAN Generation Product
License: MIT
License-File: LICENSE
Keywords: rfmx,nirfmx,nirfmxwlangen
Author: NI
Author-email: opensource@ni.com
Maintainer: Thangam V
Maintainer-email: thangam.v@emerson.com
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Manufacturing
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Scientific/Engineering :: Instrument Drivers
Provides-Extra: dev
Requires-Dist: fasteners (>=0.19)
Requires-Dist: grpcio (>=1.49.0,<2.0)
Requires-Dist: hightime (>=0.2.2)
Requires-Dist: numpy (>=1.22) ; python_version >= "3.9" and python_version < "3.12" and implementation_name != "pypy"
Requires-Dist: numpy (>=1.26) ; implementation_name != "pypy" and python_version == "3.12"
Requires-Dist: numpy (>=2.1) ; implementation_name == "pypy" and python_version == "3.10"
Requires-Dist: numpy (>=2.1) ; python_version >= "3.13" and python_version < "4.0" and implementation_name != "pypy"
Requires-Dist: numpy (>=2.3) ; python_version >= "3.11" and python_version < "4.0" and implementation_name == "pypy"
Requires-Dist: protobuf (>=4.21)
Project-URL: Documentation, https://nirfmx-python-nirfmxwlangen.readthedocs-hosted.com/
Project-URL: Repository, https://github.com/ni/nirfmx-python
Description-Content-Type: text/markdown

| **Info**      | Contains Python APIs for interacting with RFmx WLAN Generation Product. |
| :------------ | :------------------------------------------------------------------- |
| **Author**    | National Instruments                                                 |

# Table of Contents

- [Table of Contents](#table-of-contents)
- [About](#about)
  - [Documentation](#documentation)
  - [Operating System Support](#operating-system-support)
- [Installation](#installation)
- [License](#license)
- [Support and Feedback](#support-and-feedback)
- [Example](#example)


# About

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

**nirfmx-python** follows [Python Software Foundation](https://devguide.python.org/#status-of-python-branches)
support policy for different versions.


## RFmx Instr Python API Status

| Item                         | Details                      |
|------------------------------|-------------------------------|
| **Driver Version Tested**    | [2026 Q1](http://www.ni.com/downloads/)                      |
| **PyPI Package Version**     | v19.1                        |
| **Supported Python Versions**| Python 3.9+ (64-bit)    |
| **Documentation**            | [RFmx Instr Docs](https://nirfmx-python-nirfmxinstr.readthedocs-hosted.com/en/latest/) |


## RFmx WLAN Generation Python API Status

| Item                         | Details                      |
|------------------------------|-------------------------------|
| **Driver Version Tested**    | [2026 Q1](http://www.ni.com/downloads/)                      |
| **PyPI Package Version**     | v19.1                        |
| **Supported Python Versions**| Python 3.9+ (64-bit)    |
| **Documentation**            | [RFmx WLAN Generation Docs](https://nirfmx-python-nirfmxwlangen.readthedocs-hosted.com/en/latest/) |


## Documentation

You can find the latest API documentation for the **nirfmx-python** package
on [Read the Docs](https://nirfmx-python-nirfmxinstr.readthedocs-hosted.com/en/latest/)

Refer to the [RFmx User Manual](https://www.ni.com/docs/en-US/bundle/rfmx/page/user-manual-welcome.html)
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](https://www.ni.com/r/hw-support) for 
which versions of the driver support your hardware on a given operating system.


## Installation

You can use [pip](http://pypi.python.org/pypi/pip) to download [nirfmxwlangen](https://pypi.org/project/nirfmxwlangen/) and install it.
    
    $ python -m pip install nirfmxwlangen

## Upgrade

You can use [pip](http://pypi.python.org/pypi/pip) to upgrade [nirfmxwlangen](https://pypi.org/project/nirfmxwlangen/) package using following command:

    $ python -m pip install nirfmxwlangen --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](https://github.com/ni/grpc-device/wiki/Server-Security-Support).


## Support and Feedback

For support with Python API, hardware, the driver runtime or any other questions,
please visit [NI Community Forums](https://forums.ni.com/).

## RFmx WLAN Generation Example

```python

import nirfmxwlangen
import nirfsg

num_tx = 4
resource_names = ["RFSG0", "RFSG1", "RFSG2", "RFSG3"]
waveform_name = "Wlan"
script = (
    "script GenerateWlan\n"
    "    repeat forever\n"
    "        generate Wlan\n"
    "    end repeat\n"
    "end script"
)

wlangen_session = None
rfsg_sessions = [None] * num_tx

try:
    # Create RFSG Sessions
    active_rfsg_sessions = []
    for i in range(num_tx):
        rfsg_sessions[i] = nirfsg.Session(resource_names[i])
        rfsg_sessions[i].power_level_type = nirfsg.PowerLevelType.PEAK
        rfsg_sessions[i].external_gain = 0.0
        active_rfsg_sessions.append(rfsg_sessions[i])

    # Create WLAN Generation Session
    wlangen_session = nirfmxwlangen.Session(
        nirfmxwlangen.CompatibilityVersion.Version060000, "WlanGenSession"
    )

    # Configure WLAN MIMO OFDM standard and parameters
    wlangen_session.set_standard("", nirfmxwlangen.Standard.STANDARD_80211AX_MIMO_OFDM)
    wlangen_session.set_channel_bandwidth("", 80e6)
    wlangen_session.set_number_of_transmit_channels("", num_tx)
    wlangen_session.set_mcs_index("", 0)
    wlangen_session.set_mapping_matrix_type("", nirfmxwlangen.MappingMatrixType.DIRECT)
    wlangen_session.set_number_of_space_time_streams("", num_tx)
    wlangen_session.set_lo_frequency_offset_mode("", nirfmxwlangen.LOFrequencyOffsetMode.AUTO)
    wlangen_session.set_rf_blanking_enabled("", nirfmxwlangen.RFBlankingEnabled.TRUE)

    # Configure Multiple Device Synchronization
    wlangen_session.rfsg_configure_multiple_device_synchronization(
        active_rfsg_sessions, "PXI_Clk", [0, 1]
    )

    # Configure Frequency using Single LO
    wlangen_session.rfsg_configure_frequency_single_lo(
        active_rfsg_sessions,
        nirfmxwlangen.LOSource.ONBOARD,
        rfsg_sessions[0],
        5.18e9,
        False,
        False,
    )

    # Create and Download MIMO Waveforms
    wlangen_session.rfsg_create_and_download_mimo_waveforms(
        active_rfsg_sessions, None, waveform_name
    )

    # Configure Script for each RFSG device
    for i in range(num_tx):
        wlangen_session.rfsg_configure_script(rfsg_sessions[i], "", script, -10.0)

    # Initiate Multiple Device Generation
    wlangen_session.rfsg_multiple_device_initiate(active_rfsg_sessions)

    # Print Results
    iq_rate, _ = wlangen_session.get_iq_rate("")
    iq_waveform_size, _ = wlangen_session.get_iq_waveform_size("")
    waveform_duration = iq_waveform_size / iq_rate if iq_rate != 0 else 0
    print("------------------WLAN Generate MIMO OFDM Waveform (Multiple RFSG)------------------")
    print(f"Waveform Duration {{s}}{waveform_duration}")
    print("Actual Headroom (dB)")
    for i in range(num_tx):
        actual_headroom, _ = wlangen_session.get_actual_headroom(f"channel{i}")
        print(f"\t{actual_headroom}")

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

finally:
    # Stop Generation and Close Sessions
    for i in range(num_tx):
        if rfsg_sessions[i] is not None:
            rfsg_sessions[i].abort()
            rfsg_sessions[i].output_enabled = False
            rfsg_sessions[i].commit()

    if wlangen_session is not None:
        for i in range(num_tx):
            if rfsg_sessions[i] is not None:
                wlangen_session.rfsg_clear_database(rfsg_sessions[i], "", waveform_name)
        wlangen_session.close()
        wlangen_session = None

    for i in range(num_tx):
        if rfsg_sessions[i] is not None:
            rfsg_sessions[i].close()
            rfsg_sessions[i] = None
```
