Skip to main content

NI-DCPower Python API

Project description

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

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

Author

NI

About

The nidcpower module provides a Python API for NI-DCPower. The code is maintained in the Open Source repository for nimi-python.

Support Policy

nidcpower supports all the Operating Systems supported by NI-DCPower.

It follows Python Software Foundation support policy for different versions of CPython.

NI-DCPower Python API Status

NI-DCPower (nidcpower)

Driver Version Tested Against

2024 Q2

PyPI Version

Latest NI-DCPower Version

Supported Python Version

NI-DCPower supported Python versions

Documentation

NI-DCPower Python API Documentation Status

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

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/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: {} 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-{}'.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

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

Project details


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.8.tar.gz (118.8 kB view details)

Uploaded Source

Built Distribution

nidcpower-1.4.8-py3-none-any.whl (122.2 kB view details)

Uploaded Python 3

File details

Details for the file nidcpower-1.4.8.tar.gz.

File metadata

  • Download URL: nidcpower-1.4.8.tar.gz
  • Upload date:
  • Size: 118.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for nidcpower-1.4.8.tar.gz
Algorithm Hash digest
SHA256 6880777ec6138c4bad812339b96107f0351573bcf701391e4443b44021b2a392
MD5 b6f3a1f42c36dc41e97eceaf3aaa6d30
BLAKE2b-256 8cab2cf2f7e95e30e185e128a4859ae2940144f533db4fb09dbc5f4afe9bf4c7

See more details on using hashes here.

File details

Details for the file nidcpower-1.4.8-py3-none-any.whl.

File metadata

  • Download URL: nidcpower-1.4.8-py3-none-any.whl
  • Upload date:
  • Size: 122.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for nidcpower-1.4.8-py3-none-any.whl
Algorithm Hash digest
SHA256 35b2094f66c594893e37fd50c07e8a4bb711f31f5bd4b0540f3e168e3376e0c1
MD5 ffd735ae84f4867bc9209283e4d82ce7
BLAKE2b-256 462dae41a103a0c297bf534cd8004e74b4f9de113c93f7b56898c88551badc9a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page