master branch status
GitHub status
Versions	NI-DMM
	NI-ModInst

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

• NI-DMM (Python module: nidmm)

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 only the Windows operating system.

nimi-python supports CPython 3.6+. * TODO(marcoskirsch): Add PyPI version here.*

In order to use nimi-python modules, you must install the corresponding driver runtime on your system. Visit ni.com/downloads to download the latest driver version for your devices.

Specific Python bindings (i.e. for NI-DMM) can be installed with pip:

$ python -m pip install nidmm

Or easy_install from setuptools:

$ python -m easy_install nidmm

You also can download the project source, build, and run:

$ python TODO(marcoskirsch): how do we build?
$ python setup.py install

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

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.

Refer to your driver documentation for device-specific information and detailed API documentation.

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.