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)
• 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-DCPower (nidcpower)
Driver Version Tested Against	18.1.1
Driver API Version	19.6.0d2
PyPI Version
Supported Python Version
Open Issues
Open Pull Requests

NI-Digital Pattern Driver (nidigital)
Driver Version Tested Against	19.1.0
Driver API Version	19.0.0a0
PyPI Version
Supported Python Version
Open Issues
Open Pull Requests

NI-DMM (nidmm)
Driver Version Tested Against	18.1.0
Driver API Version	19.6.0d0
PyPI Version
Supported Python Version
Open Issues
Open Pull Requests

NI-FGEN (nifgen)
Driver Version Tested Against	18.1.0
Driver API Version	19.6.0d0
PyPI Version
Supported Python Version
Open Issues
Open Pull Requests

NI-ModInst (nimodinst)
Driver Version Tested Against	18.0.0
Driver API Version	255.0.0d4
PyPI Version
Supported Python Version
Open Issues
Open Pull Requests

NI-SCOPE (niscope)
Driver Version Tested Against	18.1.0
Driver API Version	19.1.0d50
PyPI Version
Supported Python Version
Open Issues
Open Pull Requests

NI Switch Executive (nise)
Driver Version Tested Against	18.0.0
Driver API Version	19.1.0d1
PyPI Version
Supported Python Version
Open Issues
Open Pull Requests

NI-SWITCH (niswitch)
Driver Version Tested Against	18.0.0
Driver API Version	19.1.0d2
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
• nise

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