nidigital 1.4.4

NI-Digital Pattern Driver Python API

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-Digital Pattern Driver Python API Status

NI-Digital Pattern Driver (nidigital)
Driver Version Tested Against	2023 Q2
PyPI Version
Supported Python Version
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.4.4

Or easy_install from setuptools:

$ python -m easy_install nidigital

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

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