Skip to main content

NI-ModInst Python API

Project description

| master branch status | |BuildStatus| |Docs| |MITLicense| |
| GitHub status | |OpenIssues| |OpenPullRequests| |
| Versions | NI-DMM | |DMMLatestVersion| |DMMPythonVersion| |
| +------------+-----------------------------------------------+
| | NI-ModInst | |ModInstLatestVersion| |ModInstPythonVersion| |

=========== =================================================================================================================
Info Python bindings for NI Modular Instrument drivers. See `GitHub <>`_ for the latest source.
Author National Instruments
=========== =================================================================================================================

| WARNING!! | NI Modular Instruments Python API is currently under development. You |
| | are welcome to use it, and we welcome feedback, but be prepared for |
| | changes to the APIs. |

.. _about-section:


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

.. _installation-section:


In order to use nimi-python modules, you must install the corresponding driver runtime on your system. Visit ` <>`_ 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 install

.. _usage-section:


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.

.. code-block:: python

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

.. _support-section:

Support / Feedback

The packages included in **nimi-python** package are supported by NI. For support, open
a request through the NI support portal at ` <>`_.

.. _bugs-section:

Bugs / Feature Requests

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

Information to Include When Asking for Help

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-section:


Documentation is available `here <>`_.

Additional Documentation

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

.. _license-section:


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

.. |BuildStatus| image::
:alt: Build Status - master branch
:scale: 100%

.. |Docs| image::
:alt: Documentation Status - master branch
:scale: 100%

.. |MITLicense| image::
:alt: MIT License
:scale: 100%

.. |CoverageStatus| image::
:alt: Test Coverage - master branch
:scale: 100%

.. |DMMLatestVersion| image::
:alt: Latest NI-DMM Version
:scale: 100%

.. |ModInstLatestVersion| image::
:alt: Latest NI-ModInst Version
:scale: 100%

.. |DMMPythonVersion| image::
:alt: NI-DMM supported Python versions
:scale: 100%

.. |ModInstPythonVersion| image::
:alt: NI-ModInst supported Python versions
:scale: 100%

.. |OpenIssues| image::
:alt: Open Issues + Pull Requests
:scale: 100%

.. |OpenPullRequests| image::
:alt: Open Pull Requests
:scale: 100%

.. |CoverageStatus|

Download files

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

Files for nimodinst, version 0.1.0.dev2
Filename, size File type Python version Upload date Hashes
Filename, size nimodinst-0.1.0.dev2-py2.py3-none-any.whl (12.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size nimodinst-0.1.0.dev2.tar.gz (8.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page