https://github.com/ni/nifpga-python

Python API for LabVIEW FPGA devices
https://github.com/ni/nifpga-python

labview-fpga national-instruments ni-fpga

Last synced: 22 days ago
JSON representation

Python API for LabVIEW FPGA devices

• Host: GitHub
• URL: https://github.com/ni/nifpga-python
• Owner: ni
• License: mit
• Created: 2017-03-01T18:43:56.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-11-16T20:59:23.000Z (about 2 years ago)
• Last Synced: 2024-04-24T09:01:09.914Z (9 months ago)
• Topics: labview-fpga, national-instruments, ni-fpga
• Language: Python
• Homepage:
• Size: 447 KB
• Stars: 68
• Watchers: 26
• Forks: 16
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
FPGA Interface Python API

=========================

[![Build Status](https://travis-ci.org/ni/nifpga-python.svg?branch=master)](https://travis-ci.org/ni/nifpga-python)

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](http://nifpga-python.readthedocs.io/en/latest/) for more detailed examples and documentation.