Overall Status
master branch status |
|
GitHub status |
|
Info |
Python bindings for NI Modular Instrument drivers. See GitHub for the latest source. |
Author |
National Instruments |
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-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)
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.
NI-ModInst Python API Status
NI-ModInst (nimodinst) |
|
|---|---|
Driver Version Tested Against |
17.0.0 |
PyPI Version |
|
Supported Python Version |
|
Open Issues |
|
Open Pull Requests |
Installation
As a prerequisite to using the nimodinst module, you must install the NI-ModInst runtime on your system. Visit ni.com/downloads to download the driver runtime for your devices.
The nimi-python modules (i.e. for NI-ModInst) can be installed with pip:
$ python -m pip install nimodinst
Or easy_install from setuptools:
$ python -m easy_install nimodinst
Contributing
We welcome contributions! You can clone the project repository, build it, and install it by following these instructions.
Usage
The following is a basic example of using the nimodinst module to retrieve information on all High Speed Digitizers currently in the system.
import nimodinst
with nimodinst.Session("niscope") as session:
for device in session:
print("{: >20} {: >15} {: >10}".format(device.device_name, device.device_model, device.serial_number))Additional examples for NI-ModInst are located in src/nimodinst/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.
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.7.0
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.7.0.tar.gz | 12.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| nimodinst-0.7.0-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 28.9 kB
Release files / nimodinst-0.7.0.tar.gz
| Download URL | nimodinst-0.7.0.tar.gz |
|---|---|
| Size | 12.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
92cb67d3c258d949873a29b053fb2a16157774b323d1f5bc3ee7648dd17635e0
|
|
BLAKE2b-256 checksum How to use checksums |
57b88c3187d065f0afe1937b3ff68bbb8160f7b5f518af30f615941a8c227aa4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / nimodinst-0.7.0-py2.py3-none-any.whl
| Download URL | nimodinst-0.7.0-py2.py3-none-any.whl |
|---|---|
| Size | 16.8 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
8ada20b7f8fd98a8d96f4a2ba104deabbd0eb8d0a100446edf78f03282a66030
|
|
BLAKE2b-256 checksum How to use checksums |
df7ee8affbbef4683d6ae93f99b8e610f12ee81392526c3233a984a58aa30a46
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
