nidmm

Overall Status

+----------------------+------------------------------------------------------------------------------------------------------------------------------------+ | master branch status | |BuildStatus| |MITLicense| |CoverageStatus| | +----------------------+------------------------------------------------------------------------------------------------------------------------------------+ | GitHub status | |OpenIssues| |OpenPullRequests| | +----------------------+------------------------------------------------------------------------------------------------------------------------------------+

=========== ============================================================================================================================ Info Python bindings for NI Modular Instrument drivers. See GitHub <https://github.com/ni/nimi-python/>_ for the latest source. Author NI =========== ============================================================================================================================

.. |BuildStatus| image:: https://api.travis-ci.com/ni/nimi-python.svg :alt: Build Status - master branch :target: https://travis-ci.org/ni/nimi-python

.. |MITLicense| image:: https://img.shields.io/badge/License-MIT-yellow.svg :alt: MIT License :target: https://opensource.org/licenses/MIT

.. |CoverageStatus| image:: https://codecov.io/github/ni/nimi-python/graph/badge.svg :alt: Test Coverage - master branch :target: https://codecov.io/github/ni/nimi-python

.. |OpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python.svg :alt: Open Issues + Pull Requests :target: https://github.com/ni/nimi-python/issues

.. |OpenPullRequests| image:: https://img.shields.io/github/issues-pr/ni/nimi-python.svg :alt: Open Pull Requests :target: https://github.com/ni/nimi-python/pulls

.. _about-section:

About

The nidmm module provides a Python API for NI-DMM. The code is maintained in the Open Source repository for nimi-python <https://github.com/ni/nimi-python>_.

Support Policy

nidmm supports all the Operating Systems supported by NI-DMM.

It follows Python Software Foundation <https://devguide.python.org/#status-of-python-branches>_ support policy for different versions of CPython.

NI-DMM Python API Status

+-------------------------------+----------------------+ | NI-DMM (nidmm) | | +===============================+======================+ | Driver Version Tested Against | 2025 Q1 | +-------------------------------+----------------------+ | PyPI Version | |nidmmLatestVersion| | +-------------------------------+----------------------+ | Supported Python Version | |nidmmPythonVersion| | +-------------------------------+----------------------+ | Documentation | |nidmmDocs| | +-------------------------------+----------------------+ | Open Issues | |nidmmOpenIssues| | +-------------------------------+----------------------+ | Open Pull Requests | |nidmmOpenPRs| | +-------------------------------+----------------------+

.. |nidmmLatestVersion| image:: http://img.shields.io/pypi/v/nidmm.svg :alt: Latest NI-DMM Version :target: http://pypi.python.org/pypi/nidmm

.. |nidmmPythonVersion| image:: http://img.shields.io/pypi/pyversions/nidmm.svg :alt: NI-DMM supported Python versions :target: http://pypi.python.org/pypi/nidmm

.. |nidmmDocs| image:: https://readthedocs.org/projects/nidmm/badge/?version=latest :alt: NI-DMM Python API Documentation Status :target: https://nidmm.readthedocs.io/en/latest

.. |nidmmOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/nidmm.svg :alt: Open Issues + Pull Requests for NI-DMM :target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Anidmm

.. |nidmmOpenPRs| image:: https://img.shields.io/github/issues-pr/ni/nimi-python/nidmm.svg :alt: Pull Requests for NI-DMM :target: https://github.com/ni/nimi-python/pulls?q=is%3Aopen+is%3Aissue+label%3Anidmm

.. _nidmm_installation-section:

Installation

As a prerequisite to using the nidmm module, you must install the NI-DMM runtime on your system. Visit ni.com/downloads <http://www.ni.com/downloads/>_ to download the driver runtime for your devices.

The nimi-python modules (i.e. for NI-DMM) can be installed with pip <http://pypi.python.org/pypi/pip>_::

$ python -m pip install nidmm~=1.4.9

Contributing

We welcome contributions! You can clone the project repository, build it, and install it by following these instructions <https://github.com/ni/nimi-python/blob/master/CONTRIBUTING.md>_.

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.

.. code-block:: python

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. <https://github.com/ni/nimi-python/tree/master/src/nidmm/examples>_

.. _support-section:

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 <https://forums.ni.com/>.

.. _bugs-section:

Bugs / Feature Requests

To report a bug or submit a feature request specific to Python API, please use the GitHub issues page <https://github.com/ni/nimi-python/issues>_.

Fill in the issue template as completely as possible and we will respond as soon as we can.

.. _documentation-section:

Documentation

Documentation is available here <http://nidmm.readthedocs.io>_.

.. _license-section:

License

nimi-python is licensed under an MIT-style license (see LICENSE <https://github.com/ni/nimi-python/blob/master/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 <https://github.com/ni/nimi-python/blob/master/NILICENSE>_).