master branch status
GitHub status

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)

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-DCPower (nidcpower)
Driver Version Tested Against	17.6.0
PyPI Version
Supported Python Version
Open Issues
Open Pull Requests

NI-DMM (nidmm)
Driver Version Tested Against	17.1.0
PyPI Version
Supported Python Version
Open Issues
Open Pull Requests

NI-FGEN (nifgen)
Driver Version Tested Against	17.1.0
PyPI Version
Supported Python Version
Open Issues
Open Pull Requests

NI-ModInst (nimodinst)
Driver Version Tested Against	17.0.0
PyPI Version
Supported Python Version
Open Issues
Open Pull Requests

NI-SCOPE (niscope)
Driver Version Tested Against	17.0.2
PyPI Version
Supported Python Version
Open Issues
Open Pull Requests

NI-SWITCH (niswitch)
Driver Version Tested Against	17.0.0
PyPI Version
Supported Python Version
Open Issues
Open Pull Requests

Driver specific installation instructions can be found on Read The Docs:

• nidcpower
• nidmm
• nifgen
• niscope
• niswitch
• nimodinst

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

The following is a basic example of using the nidmm module to open a session to a DMM and perform a 5.5 digits of resolution voltage measurement in the 10 V range.

import nidmm
with nidmm.Session("Dev1") as session:
    session.configureMeasurementDigits(nidmm.Function.DC_VOLTS, 10, 5.5)
    print("Measurement: " + str(session.read()))

Additional examples for NI-DMM are located in src/nidmm/examples/ directory.

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

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

Please include all of the following information when opening an issue:

• Detailed steps on how to reproduce the problem and full traceback, if applicable. Code samples are encouraged!

• The python version used:

  $ python -c "import sys; print(sys.version)"
  

• The module (i.e. nidmm) and its version:

  $ python -m pip list
  

• The version of the driver used (i.e. NI-DMM 17.1). Follow this KB article to determine the version you have installed.

• The operating system, version, and bitness. For example 64-bit Windows 7.

Documentation is available here.

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.