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
Info Python bindings for NI Modular Instrument drivers. See GitHub for the latest source.
Author National Instruments

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

NI-DCPower Python API Status

NI-DCPower (nidcpower)  
Driver Version Tested Against 20.5.0
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

Installation

As a prerequisite to using the nidcpower module, you must install the NI-DCPower runtime on your system. Visit ni.com/downloads 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.3.2

Or easy_install from setuptools:

$ python -m easy_install nidcpower

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 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', channels='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

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

    samples_acquired = 0
    print('  #    Voltage    Current    In Compliance')
    row_format = '{0:3d}:   {1:8.6f}   {2:8.6f}   {3}'
    with session.initiate():
        while samples_acquired < 20:
            measurements = session.fetch_multiple(count=session.fetch_backlog)
            samples_acquired += len(measurements)
            for i in range(len(measurements)):
                print(row_format.format(i, measurements[i].voltage, measurements[i].current, measurements[i].in_compliance))

Additional examples for NI-DCPower are located in src/nidcpower/examples/ directory.

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.

Download files

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

Files for nidcpower, version 1.3.2
Filename, size File type Python version Upload date Hashes
Filename, size nidcpower-1.3.2-py2.py3-none-any.whl (52.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size nidcpower-1.3.2.tar.gz (53.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page