Skip to main content

Python API for interacting with National Instrument's LabVIEW FPGA Devices

Project description

FPGA Interface Python API

Build Status

Overview

The National Instruments FPGA Interface Python API is used for communication between processor and FPGA within NI reconfigurable I/O (RIO) hardware such as NI CompactRIO, NI Single-Board RIO, NI FlexRIO, and NI R Series multifunction RIO.

With the FPGA Interface Python API, developers can use LabVIEW FPGA to program the FPGA within NI hardware and communicate to it from Python running on a host computer. This gives engineers and scientists with Python expertise the ability to take advantage of compiled LabVIEW FPGA bitfiles, also the option to reuse existing Python code.

Installation

NiFpga can be installed by cloning the master branch and then in a command line in the directory of setup.py run:

pip install --pre .

Or by installing from PyPI using:

pip install nifpga

nifpga supports Python 3.5+.

Examples

The FPGA Interface Python API is session based. LabVIEW FPGA will generate bitfiles (.lvbitx) that can be used to program the hardware. For additional information on sessions view our Read the docs documentation

Example usage of FPGA configuration functions:

with Session(bitfile="BitfilePath.lvbitx", resource="RIO0") as session:
    session.reset()
    session.run()
    my_control = session.registers["MyControl"]
    my_control.write(4)
    data = my_control.read()

See our readthedocs page for more detailed examples and documentation.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

nifpga-22.0.0-py3-none-any.whl (38.3 kB view details)

Uploaded Python 3

File details

Details for the file nifpga-22.0.0-py3-none-any.whl.

File metadata

  • Download URL: nifpga-22.0.0-py3-none-any.whl
  • Upload date:
  • Size: 38.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.7.9

File hashes

Hashes for nifpga-22.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 51e858f810bd331be6ad84ed58a87b2a6aa37b529eb2294e4e087fc6b12fe36d
MD5 a74c2b3d39f351d72b2cb59e461329d3
BLAKE2b-256 31e8d48ff01b18eec5e0f49a7e79038481308d0b3e76dd4043159a17dbeae579

See more details on using hashes here.

Supported by

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