NI-ModInst Python API
|master branch status|
|Info||Python bindings for NI Modular Instrument drivers. See GitHub for the latest source.|
|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.|
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)
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.
As a prerequisite to using nimi-python modules, you must install the corresponding driver runtime on your system. Visit 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:
$ python -m pip install nidmm
Or easy_install from setuptools:
$ python -m easy_install nidmm
You also can clone the project repository, build it, and install it:
$ git clone https://github.com/ni/nimi-python.git $ make $ pip install -U bin\nidmm\dist\nidmm-0.1-py2.py3-none-any.whl
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 each driver are located in src/<driver>/examples/ directory.
Support / Feedback
The packages included in nimi-python package are supported by NI. For support, open a request through the NI support portal at ni.com.
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 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.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size nimodinst-0.4.0.dev0-py2.py3-none-any.whl (15.1 kB)||File type Wheel||Python version py2.py3||Upload date||Hashes View|
|Filename, size nimodinst-0.4.0.dev0.tar.gz (10.7 kB)||File type Source||Python version None||Upload date||Hashes View|
Hashes for nimodinst-0.4.0.dev0-py2.py3-none-any.whl