This release is a pre-release and may not be stable for production use.
master branch status |
|
|
GitHub status |
|
|
Versions |
NI-DMM |
|
NI-ModInst |
|
|
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
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)
NI-ModInst (Python module: nimodinst)
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 supports Python 2.7, 3.4 and later using CPython or PyPy.
Installation
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
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.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
Documentation is available here.
Additional Documentation
Refer to your driver documentation for device-specific information and detailed API documentation.
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.
5 maintainers
Metadata
5 maintainers
Release files for nimodinst 0.2.0.dev0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| nimodinst-0.2.0.dev0.tar.gz | 8.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| nimodinst-0.2.0.dev0-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 21.9 kB
Release files / nimodinst-0.2.0.dev0.tar.gz
| Download URL | nimodinst-0.2.0.dev0.tar.gz |
|---|---|
| Size | 8.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
94262a0ade1aaabc0872738843cfc5ed3d463ee3391b85c5af78c8ca88f90716
|
|
BLAKE2b-256 checksum How to use checksums |
6e263c1470e4f7e32ae91eabda7344b5060c8eeec4dc77743d8583ce053eb46a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / nimodinst-0.2.0.dev0-py2.py3-none-any.whl
| Download URL | nimodinst-0.2.0.dev0-py2.py3-none-any.whl |
|---|---|
| Size | 13.3 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
6736c27dfc7ecbcfcac625858a8a3c1b310fc0c78ded1e4570e92ee2af0d9153
|
|
BLAKE2b-256 checksum How to use checksums |
0e2fbfedbc564472e6f52b446dd8204c47f31a0e7b234a2b0f3ad9a20cba26dc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
