Skip to main content

NI-FGEN Python API

Project description

Overall Status

master branch status

Build Status - master branch MIT License Test Coverage - master branch

GitHub status

Open Issues + Pull Requests Open Pull Requests

Info

Python bindings for NI Modular Instrument drivers. See GitHub for the latest source.

Author

NI

About

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

Support Policy

nifgen supports all the Operating Systems supported by NI-FGEN.

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

NI-FGEN Python API Status

NI-FGEN (nifgen)

Driver Version Tested Against

2025 Q1

PyPI Version

Latest NI-FGEN Version

Supported Python Version

NI-FGEN supported Python versions

Documentation

NI-FGEN Python API Documentation Status

Open Issues

Open Issues + Pull Requests for NI-FGEN

Open Pull Requests

Pull Requests for NI-FGEN

Installation

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

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

$ python -m pip install nifgen~=1.4.9

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 nifgen module to open a session to a Function Generator and generate a sine wave for 5 seconds.

import nifgen
import time
with nifgen.Session("Dev1") as session:
    session.output_mode = nifgen.OutputMode.FUNC
    session.configure_standard_waveform(waveform=nifgen.Waveform.SINE, amplitude=1.0, frequency=10000000, dc_offset=0.0, start_phase=0.0)
    with session.initiate():
        time.sleep(5)

Other usage examples can be found on GitHub.

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).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nifgen-1.4.9.tar.gz (94.9 kB view details)

Uploaded Source

Built Distribution

nifgen-1.4.9-py3-none-any.whl (97.1 kB view details)

Uploaded Python 3

File details

Details for the file nifgen-1.4.9.tar.gz.

File metadata

  • Download URL: nifgen-1.4.9.tar.gz
  • Upload date:
  • Size: 94.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for nifgen-1.4.9.tar.gz
Algorithm Hash digest
SHA256 900f1ba20d2db643dd7c5ae04bbdff921d84e5fdf9baed0bbe4931e0cce1487d
MD5 276c275e6d05c5e642b31a3f58b5cd5b
BLAKE2b-256 e5ef16ed60e341f377c4afa8e73468278a2370c6befda614532e7e094892bb70

See more details on using hashes here.

File details

Details for the file nifgen-1.4.9-py3-none-any.whl.

File metadata

  • Download URL: nifgen-1.4.9-py3-none-any.whl
  • Upload date:
  • Size: 97.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for nifgen-1.4.9-py3-none-any.whl
Algorithm Hash digest
SHA256 8d3617aae6ba5f0635eed17d14b2615e01166f62271a6a8124441ee500aee33d
MD5 c7ae38ecb037c486ad8c928f88ba257c
BLAKE2b-256 038250f194527ef9a5d14b35e13dec09dc334c2f93c898e67aad50b97182ca24

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page