Skip to main content

Overall Status

master branch status

Build Status - master branch MIT License Test Coverage - master branch

GitHub status

Open Issues + Pull Requests Open Pull Requests

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

Latest NI-Digital Pattern Driver Version

Supported Python Version

NI-Digital Pattern Driver supported Python versions

Documentation

NI-Digital Pattern Driver Python API Documentation Status

Open Issues

Open Issues + Pull Requests for NI-Digital Pattern Driver

Open Pull Requests

Pull Requests for NI-Digital Pattern Driver

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.DISCONNECT

Other 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).

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nidigital-1.5.0.tar.gz (95.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nidigital-1.5.0-py3-none-any.whl (97.3 kB view details)

Uploaded Python 3

File details

Details for the file nidigital-1.5.0.tar.gz.

File metadata

  • Download URL: nidigital-1.5.0.tar.gz
  • Upload date:
  • Size: 95.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for nidigital-1.5.0.tar.gz
Algorithm Hash digest
SHA256 114deab3a92b19bd5841d633536e5e97973f3dc660311b977f0ef9890db6db70
MD5 bd377169b00b6c38f310dfac5e089e71
BLAKE2b-256 116d76ff276a8702b42d6b007a4ebe645fb9237ac781818537c5054c2bef5d83

See more details on using hashes here.

File details

Details for the file nidigital-1.5.0-py3-none-any.whl.

File metadata

  • Download URL: nidigital-1.5.0-py3-none-any.whl
  • Upload date:
  • Size: 97.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for nidigital-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 db215d9c1ebc9a518ffc68cf6e5979cbf433429da24049e13abe6b683beb4161
MD5 e053df56c5e088c09c1c25a8a0788246
BLAKE2b-256 4e312eceeb5065eb92ca2e88c34fae50239025b5e740e9e81c6df318a41f9f1c

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.5.0 This release

2 files

1.4.9

2 files

1.4.8

2 files

1.4.7

2 files

1.4.6

2 files

1.4.5

2 files

1.4.4

2 files

1.4.3

2 files

1.4.2

2 files

1.4.1

2 files

1.4.0

2 files

1.0.0

2 files

0.9.2

2 files

0.9.1

2 files

0.9.0

2 files

0.5.0

2 files

0.4.0

2 files

0.2.1

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page