Overall Status
master branch status |
|
GitHub status |
|
Info |
Python bindings for NI Modular Instrument drivers. See GitHub for the latest source. |
Author |
NI |
About
The nimi-python repository generates Python bindings (Application Programming Interface) for interacting with the Modular Instrument drivers. The following drivers are supported:
NI-DCPower (Python module: nidcpower)
NI-Digital Pattern Driver (Python module: nidigital)
NI-DMM (Python module: nidmm)
NI-FGEN (Python module: nifgen)
NI-ModInst (Python module: nimodinst)
NI-SCOPE (Python module: niscope)
NI Switch Executive (Python module: nise)
NI-SWITCH (Python module: niswitch)
NI-TClk (Python module: nitclk)
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 follows Python Software Foundation support policy for different versions. At this time this includes Python 3.7 and above using CPython.
NI-ModInst Python API Status
NI-ModInst (nimodinst) |
|
|---|---|
Driver Version Tested Against |
2023 Q2 |
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~=1.4.4
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))Other usage examples can be found on GitHub.
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 specific to NI Modular Instruments Python bindings (nimi-python), please use the GitHub issues page.
Fill in the issue template as completely as possible and we will respond as soon as we can.
For hardware support or any other questions not specific to this GitHub project, please visit NI Community Forums.
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.
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).
5 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file nimodinst-1.4.4.tar.gz.
File metadata
- Download URL: nimodinst-1.4.4.tar.gz
- Upload date:
- Size: 18.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
156a406adde0e68b0ffd0532e740ecf05302a28e868ec3a88010e70c5020f4c6
|
|
| MD5 |
d2aa5e65e3700db423038045b981a85c
|
|
| BLAKE2b-256 |
5531e507052f7f0443bd1dda82cdde14da6579cc1db84b3f4758446a139bfe98
|
File details
Details for the file nimodinst-1.4.4-py3-none-any.whl.
File metadata
- Download URL: nimodinst-1.4.4-py3-none-any.whl
- Upload date:
- Size: 17.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9ab01f01d94005b8df574e77ae1c503de1b7e1feba1acb7715965444aa8311ff
|
|
| MD5 |
6e72e3261a9d30900e2eba6f0a7f08e0
|
|
| BLAKE2b-256 |
16f8eae0627cd2de701d3e723771c4d5d23e13a005a6e2d0fa46930ea7aee787
|
