Package: nifpga-fast-fifo-recv
nifpga-fast-fifo-recvAn unofficial Python module for fast reading of data from NI FPGA FIFOs with a separate thread.This module provides in Python a class and the methods to start a separate thread which acquire continously
data and store them into a queue which can be read asynchronously.
This allows to receive data from FPGA in Python ideally without loosing data even for fast data-rate.The module is developed in Rust by usingmaturin,pyo3and the Rust librarynifpga-dll, an unofficial Rust bindings toNiFpga.dlllibrary.
As described in the example below,nifpga-fast-fifo-recvdoes not require thenifpgaPython module but in typical applications is strongly recommended to use with it.Disclaimer:Thenifpga-fast-fifo-recvPython module is NOT an official NI library!This library is an independent and autonomous development, unaffiliated with NI.UsageInstallationpip install nifpga-fast-fifo-recvExamplefromnifpga_fast_fifo_recvimportNifpgaFastFifoRecvfifo=NifpgaFastFifoRecv(bitfile="myfile.lvbitx",signature=bitfile_signature,ni_address="RIO0",run=False,close_on_reset=True,fifo=fifo_number,dma_buffer_size=500000,fifo_reading_buffer=10000,min_packet=2,)fifo.thread_start()assert(fifo.thread_status()==True)foriinrange(0,100):data=fifo.get_data()print(data)do_something_complicate(data)fifo.thread_stop()assert(fifo.thread_status()==False)Please note that in the example aboverun = Falsethat means that the FPGA suppose to be already programmed
with the identical bitfile and in a run state. This can be done by external program or a high-level LabView code,
or the python script before or in a separate thread/process. For example, it is possible to make a script load,
configure some register and run the bitfile by the standardnifpgalibrary.
Once it is running it is possible at the same time use into another thread or process theNifpgaFastFifoRecv, do thethread_start()andget_data().If you do not need to control registers or other things you can directly run the bitfile fromNifpgaFastFifoRecvsimply by setrun = True.How to get thesignatureand thefifo_number(from FIFO name)Thenifpga_fast_fifo_recvin can work alone but in real application is used withnifpga.
The bit file.lvbitxis actually an XML file. There is possible to find its signature and the correspondence between
FIFO-number and FIFO name given at LabView compilation time.
Note typically if you have a single fifo in the bitfile,fifo=0.
Thenifpgalibrary can ease to extract the signature and the fifo number from the bitfile.importnifpgabitfile_reader=nifpga.Bitfile(bitfile)bitfile_signature=bitfile_reader.signaturebitfile_fifo_number={i:nforn,iinenumerate(self.bitfile_reader.fifos.keys())}fifo_number=bitfile_fifo_number["MYFIFO"]Object structureThe module structure is the following:class NifpgaFastFifoRecv(object)
     |
     |  NifpgaFastFifoRecv(bitfile='X', signature='ABCD12345678', ni_address='RI0', run=False, close_on_reset=False, fifo=0, dma_buffer_size=50000, fifo_reading_buffer=10000, min_packet=1)
     |  
     |  Methods defined here:
     |  
     |  get_conf(self, /)
     |      get the current configuration
     |  
     |  get_data(self, /)
     |      get data from the internal queue
     |  
     |  thread_is_running(self, /)
     |      thread_is_running return true is thread is running
     |  
     |  thread_start(self, /)
     |      thread_start run the thread
     |  
     |  thread_stop(self, /)
     |      thread_stop stop the threadDeveloperIn order to compile this project you needmaturinpip install maturinand you need also theNiFpga.dllinstalled in your system.LicenseCopyright (c) 2023 Istituto Italiano di TecnologiaPermission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.