Overall Status

master branch status
GitHub status

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

About

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

• NI-DCPower (Python module: nidcpower)
• NI-Digital Pattern Driver (Python module: nidigital)
• NI-DMM (Python module: nidmm)
• NI-FGEN (Python module: nifgen)
• NI-ModInst (Python module: nimodinst)
• NI-SCOPE (Python module: niscope)
• NI Switch Executive (Python module: nise)
• NI-SWITCH (Python module: niswitch)
• NI-TClk (Python module: nitclk)

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 follows Python Software Foundation support policy for different versions.

NI-DCPower Python API Status

NI-DCPower (nidcpower)
Driver Version Tested Against	2024 Q2
PyPI Version
Supported Python Version
Documentation
Open Issues
Open Pull Requests

NI-Digital Pattern Driver Python API Status

NI-Digital Pattern Driver (nidigital)
Driver Version Tested Against	2024 Q2
PyPI Version
Supported Python Version
Documentation
Open Issues
Open Pull Requests

NI-DMM Python API Status

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

NI-FGEN Python API Status

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

NI-ModInst Python API Status

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

NI-SCOPE Python API Status

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

NI Switch Executive Python API Status

NI Switch Executive (nise)
Driver Version Tested Against	2023 Q1
PyPI Version
Supported Python Version
Documentation
Open Issues
Open Pull Requests

NI-SWITCH Python API Status

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

NI-TClk Python API Status

NI-TClk (nitclk)
Driver Version Tested Against	2024 Q2
PyPI Version
Supported Python Version
Documentation
Open Issues
Open Pull Requests

Installation

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

• nidcpower
• nidigital
• nidmm
• nifgen
• nimodinst
• niscope
• nise
• niswitch
• nitclk

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 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.configure_measurement_digits(nidmm.Function.DC_VOLTS, 10.0, 5.5)
    print("Measurement: " + str(session.read()))

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 on Read the Docs:

• https://nidcpower.readthedocs.io/en/stable
• https://nidigital.readthedocs.io/en/stable
• https://nidmm.readthedocs.io/en/stable
• https://nifgen.readthedocs.io/en/stable
• https://nimodinst.readthedocs.io/en/stable
• https://niscope.readthedocs.io/en/stable
• https://nise.readthedocs.io/en/stable
• https://niswitch.readthedocs.io/en/stable
• https://nitclk.readthedocs.io/en/stable

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