Metadata-Version: 2.1
Name: myRIO_library
Version: 0.4.2
Summary: A library to control the myRIO board from National Instruments
Home-page: https://github.com/AitzolEzeizaUPVEHU/myRIO_library
Download-URL: https://github.com/AitzolEzeizaUPVEHU/myRIO_library/archive/refs/heads/main.zip
Author: Aitzol Ezeiza Ramos
Author-email: aitzol.ezeiza@ehu.eus
License: MIT
Keywords: myRIO,NI,National Instruments,LabVIEW,Python,FPGA,Real-Time,Embedded Systems
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Other OS
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Requires-Dist: nifpga>=22.0.0
Requires-Dist: future>=1.0.0
Requires-Dist: Flask>=1.1.4
Requires-Dist: Jinja2>=2.11.3
Requires-Dist: Werkzeug>=1.0.1
Requires-Dist: click>=7.1.2
Requires-Dist: itsdangerous>=1.1.0
Requires-Dist: MarkupSafe>=0.23
Requires-Dist: Waitress>=1.4.0

# myRIO_library - a library for working with NI myRIO in Python

This library is an improvement over nifpga, a Python library that
gives access to the FPGA registers of NI targets with FPGA.

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

In this library, we have created some support functions and a class
named MyRIO. We call it "library" because the aim of this project is
to create a collection of packages for running Python programs in
different environments (multiple myRIOs, for example).

The current version only works locally, inside the myRIO, that runs NI Linux RT.

https://www.ni.com/en/shop/linux/under-the-hood-of-ni-linux-real-time.html

The main idea is to be able to install this library from myRIO and to
run basic functions easily.

If you want to use this library, you will need an updated NI Linux RT image,
SSH enabled (it is easy to set in NI MAX, the configuration tool), and Internet
enabled on your myRIO (check the myRIO documentation for that).

When ready, you should connect (ssh) to the myRIO and ensure that everything
is up-to-date before installing myRIO_library:

https://oldwiki.archive.openwrt.org/doc/techref/opkg

opkg update
opkg install python3 python3-misc python-pip

python -m pip install myRIO_library

Check the examples folder inside the site-packages/myRIO_library/examples folder for further help.

Last update: 2024/03/08 Aitzol Ezeiza Ramos (UPV/EHU)

