Overall Status
master branch status |
|
GitHub status |
|
Info |
NI Modular Instrument driver APIs for Python. |
Author |
NI |
About
The nidigital module provides a Python API for NI-Digital Pattern Driver. The code is maintained in the Open Source repository for nimi-python.
Support Policy
nidigital supports all the Operating Systems supported by NI-Digital Pattern Driver.
It follows Python Software Foundation support policy for different versions of CPython.
NI created and supports nidigital.
NI-Digital Pattern Driver Python API Status
NI-Digital Pattern Driver (nidigital) |
|
|---|---|
Driver Version Tested Against |
2026 Q3 |
PyPI Version |
|
Supported Python Version |
|
Documentation |
|
Open Issues |
|
Open Pull Requests |
Installation
As a prerequisite to using the nidigital module, you must install the NI-Digital Pattern 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-Digital Pattern Driver) can be installed with pip:
$ python -m pip install nidigital~=1.5.0
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 nidigital module to open a session to a digital pattern instrument, source current, and measure both voltage and current using the PPMU on selected channels.
import nidigital
import time
with nidigital.Session(resource_name='PXI1Slot2') as session:
channels = 'PXI1Slot2/0,PXI1Slot2/1'
# Configure PPMU measurements
session.channels[channels].ppmu_aperture_time = 0.000004
session.channels[channels].ppmu_aperture_time_units = nidigital.PPMUApertureTimeUnits.SECONDS
session.channels[channels].ppmu_output_function = nidigital.PPMUOutputFunction.CURRENT
session.channels[channels].ppmu_current_level_range = 0.000002
session.channels[channels].ppmu_current_level = 0.000002
session.channels[channels].ppmu_voltage_limit_high = 3.3
session.channels[channels].ppmu_voltage_limit_low = 0
# Sourcing
session.channels[channels].ppmu_source()
# Settling time between sourcing and measuring
time.sleep(0.01)
# Measuring
current_measurements = session.channels[channels].ppmu_measure(nidigital.PPMUMeasurementType.CURRENT)
voltage_measurements = session.channels[channels].ppmu_measure(nidigital.PPMUMeasurementType.VOLTAGE)
print('{:<20} {:<10} {:<10}'.format('Channel Name', 'Current', 'Voltage'))
for channel, current, voltage in zip(channels.split(','), current_measurements, voltage_measurements):
print('{:<20} {:<10f} {:<10f}'.format(channel, current, voltage))
# Disconnect all channels using programmable onboard switching
session.channels[channels].selected_function = nidigital.SelectedFunction.DISCONNECTOther usage examples can be found on GitHub.
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.
Bugs / Feature Requests
To report a bug or submit a feature request specific to Python API, please use the GitHub issues page.
Fill in the issue template as completely as possible and we will respond as soon as we can.
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
Metadata
5 maintainers
Release files for nidigital 1.5.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 | Provenance | |
|---|---|---|---|---|
| nidigital-1.5.0.tar.gz | 95.7 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| nidigital-1.5.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 193.0 kB
Release files / nidigital-1.5.0.tar.gz
| Download URL | nidigital-1.5.0.tar.gz |
|---|---|
| Size | 95.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
114deab3a92b19bd5841d633536e5e97973f3dc660311b977f0ef9890db6db70
|
|
BLAKE2b-256 checksum How to use checksums |
116d76ff276a8702b42d6b007a4ebe645fb9237ac781818537c5054c2bef5d83
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.3
|
Release files / nidigital-1.5.0-py3-none-any.whl
| Download URL | nidigital-1.5.0-py3-none-any.whl |
|---|---|
| Size | 97.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
db215d9c1ebc9a518ffc68cf6e5979cbf433429da24049e13abe6b683beb4161
|
|
BLAKE2b-256 checksum How to use checksums |
4e312eceeb5065eb92ca2e88c34fae50239025b5e740e9e81c6df318a41f9f1c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.3
|
Security for nidigital 1.5.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
