Skip to main content

NI-DCPower Python API

Project description

Overall Status

master branch status

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

GitHub status

Open Issues + Pull Requests Open Pull Requests


Python bindings for NI Modular Instrument drivers. See GitHub for the latest source.




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.6 and above using CPython.

NI-DCPower Python API Status

NI-DCPower (nidcpower)

Driver Version Tested Against

2022 Q3

PyPI Version

Latest NI-DCPower Version

Supported Python Version

NI-DCPower supported Python versions

Open Issues

Open Issues + Pull Requests for NI-DCPower

Open Pull Requests

Pull Requests for NI-DCPower


As a prerequisite to using the nidcpower module, you must install the NI-DCPower runtime on your system. Visit to download the driver runtime for your devices.

The nimi-python modules (i.e. for NI-DCPower) can be installed with pip:

$ python -m pip install nidcpower~=1.4.2

Or easy_install from setuptools:

$ python -m easy_install nidcpower


We welcome contributions! You can clone the project repository, build it, and install it by following these instructions.


The following is a basic example of using the nidcpower module to open a session to a Source Meter Unit and measure voltage and current.

import nidcpower
# Configure the session.

with nidcpower.Session(resource_name='PXI1Slot2/0') as session:
    session.measure_record_length = 20
    session.measure_record_length_is_finite = True
    session.measure_when = nidcpower.MeasureWhen.AUTOMATICALLY_AFTER_SOURCE_COMPLETE
    session.voltage_level = 5.0

    print('Effective measurement rate: {0} S/s'.format(session.measure_record_delta_time / 1))

    samples_acquired = 0
    print('Channel           Num  Voltage    Current    In Compliance')
    row_format = '{0:15} {1:3d}    {2:8.6f}   {3:8.6f}   {4}'
    with session.initiate():
        channel_indices = '0-{0}'.format(session.channel_count - 1)
        channels = session.get_channel_names(channel_indices)
        for i, channel_name in enumerate(channels):
            samples_acquired = 0
            while samples_acquired < 20:
                measurements = session.channels[channel_name].fetch_multiple(count=session.fetch_backlog)
                samples_acquired += len(measurements)
                for i in range(len(measurements)):
                    print(row_format.format(channel_name, i, measurements[i].voltage, measurements[i].current, measurements[i].in_compliance))

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

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 is available here.


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.

Download files

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

Source Distribution

nidcpower-1.4.2.tar.gz (77.4 kB view hashes)

Uploaded source

Built Distribution

nidcpower-1.4.2-py3-none-any.whl (78.7 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page