Skip to main content

NI-FGEN Python API

Project description

Overall Status

master branch status Build Status - master branch Documentation 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 National Instruments
NI Digital Multimeter with Python logo

About

The nimi-python repository generates Python bindings (Application Programming Interface) for interacting with the Modular Instrument drivers. Currently, the following drivers are supported:

  • NI-DCPower (Python module: nidcpower)
  • NI-DMM (Python module: nidmm)
  • NI-FGEN (Python module: nifgen)
  • NI-SCOPE (Python module: niscope)
  • NI-SWITCH (Python module: niswitch)
  • NI-ModInst (Python module: nimodinst)
  • NI Switch Executive (Python module: nise)

It is implemented as a set of Mako templates and per-driver metafiles that produce a Python module for each driver. The driver is called through its public C API using the ctypes Python library.

nimi-python supports all the Operating Systems supported by the underlying driver.

nimi-python supports Python 2.7, 3.4 and later using CPython or PyPy.

NI-FGEN Python API Status

NI-FGEN (nifgen)  
Driver Version Tested Against 18.1.0
PyPI Version Latest NI-FGEN Version
Supported Python Version NI-FGEN supported Python versions
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.1.0

Or easy_install from setuptools:

$ python -m easy_install nifgen

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)

Additional examples for NI-FGEN are located in src/nifgen/examples/ directory.

Support / Feedback

The packages included in nimi-python package are supported by NI. For support, open a request through the NI support portal at ni.com.

Bugs / Feature Requests

To report a bug or submit a feature request specific to NI Modular Instruments Python bindings (nimi-python), please use the GitHub issues page.

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

For hardware support or any other questions not specific to this GitHub project, please visit [NI Community Forums](https://forums.ni.com/). .. _documentation-section:

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.

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
nifgen-1.1.0-py2.py3-none-any.whl (52.6 kB) Copy SHA256 hash SHA256 Wheel py2.py3
nifgen-1.1.0.tar.gz (50.7 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page