# 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 packages myRIO_base and myRIO_API are designed to work locally,
inside the myRIO. myRIO runs a reduced version of Linux named 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 the base library inside the myRIO and
to run basic functions easily.
If you want to use the base 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). You will need
a privileged account (in myRIO the default administrator user is admin) if you
want to have access to the FPGA registers (the basic package, nifpga, needs 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.
The myRIO_API package creates and serves an API implementation based
on myRIO_base.
Read its specific documentation and examples for more information.
And finally, the third package of the library, myRIO_API_client,
can run on any computer that supports Python. You can install it
using pip:
pip install myRIO_library
This package is a client implementation for accessing the API.
You will need communication with the myRIO (via USBLAN or WiFi)
in order to use the API. More info in the specific docs about
the myRIO_API_client package.
Last update: 2024/03/15 Aitzol Ezeiza Ramos (UPV/EHU)
Raw data
{
"_id": null,
"home_page": "https://github.com/AitzolEzeizaUPVEHU/myRIO_library",
"name": "myRIO-library",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": null,
"keywords": "myRIO, NI, National Instruments, LabVIEW, Python, FPGA, Real-Time, Embedded Systems",
"author": "Aitzol Ezeiza Ramos",
"author_email": "aitzol.ezeiza@ehu.eus",
"download_url": "https://files.pythonhosted.org/packages/c9/ef/788bb10e0f290244d37fb67d817e3767bb9b07ed529c31c328ddd026aed0/myrio_library-1.3.3.tar.gz",
"platform": null,
"description": "# myRIO_library - a library for working with NI myRIO in Python\r\n\r\nThis library is an improvement over nifpga, a Python library that\r\ngives access to the FPGA registers of NI targets with FPGA.\r\n\r\nhttps://github.com/ni/nifpga-python\r\n\r\nIn this library, we have created some support functions and a class\r\nnamed MyRIO. We call it \"library\" because the aim of this project is\r\nto create a collection of packages for running Python programs in\r\ndifferent environments (multiple myRIOs, for example).\r\n\r\nThe packages myRIO_base and myRIO_API are designed to work locally, \r\ninside the myRIO. myRIO runs a reduced version of Linux named NI Linux RT.\r\n\r\nhttps://www.ni.com/en/shop/linux/under-the-hood-of-ni-linux-real-time.html\r\n\r\nThe main idea is to be able to install the base library inside the myRIO and\r\nto run basic functions easily.\r\n\r\nIf you want to use the base library, you will need an updated NI Linux RT image,\r\nSSH enabled (it is easy to set in NI MAX, the configuration tool), and Internet\r\nenabled on your myRIO (check the myRIO documentation for that). You will need\r\na privileged account (in myRIO the default administrator user is admin) if you\r\nwant to have access to the FPGA registers (the basic package, nifpga, needs that).\r\n\r\nWhen ready, you should connect (ssh) to the myRIO and ensure that everything\r\nis up-to-date before installing myRIO_library:\r\n\r\nhttps://oldwiki.archive.openwrt.org/doc/techref/opkg\r\n\r\nopkg update\r\nopkg install python3 python3-misc python-pip\r\n\r\npython -m pip install myRIO_library\r\n\r\nCheck the examples folder inside the site-packages/myRIO_library/examples\r\nfolder for further help.\r\n\r\nThe myRIO_API package creates and serves an API implementation based \r\non myRIO_base.\r\n\r\nRead its specific documentation and examples for more information.\r\n\r\nAnd finally, the third package of the library, myRIO_API_client,\r\ncan run on any computer that supports Python. You can install it\r\nusing pip:\r\n\r\npip install myRIO_library\r\n\r\nThis package is a client implementation for accessing the API.\r\nYou will need communication with the myRIO (via USBLAN or WiFi)\r\nin order to use the API. More info in the specific docs about\r\nthe myRIO_API_client package.\r\n\r\nLast update: 2024/03/15 Aitzol Ezeiza Ramos (UPV/EHU)\r\n\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A library to control the myRIO board from National Instruments",
"version": "1.3.3",
"project_urls": {
"Download": "https://github.com/AitzolEzeizaUPVEHU/myRIO_library/archive/refs/heads/main.zip",
"Homepage": "https://github.com/AitzolEzeizaUPVEHU/myRIO_library"
},
"split_keywords": [
"myrio",
" ni",
" national instruments",
" labview",
" python",
" fpga",
" real-time",
" embedded systems"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dfd35cc916d3be83ab1f776de3a4d019e2cc2dbd2c3ee73d0f7dc44a6d177e8f",
"md5": "6c5c66e544deed3c6f05da33ea7e3bb1",
"sha256": "58e0982135b2fe7132ef8889b89aeb3dfdf2e5e5db545d850152b0bc11131cdd"
},
"downloads": -1,
"filename": "myRIO_library-1.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6c5c66e544deed3c6f05da33ea7e3bb1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 994890,
"upload_time": "2024-04-15T08:36:36",
"upload_time_iso_8601": "2024-04-15T08:36:36.183796Z",
"url": "https://files.pythonhosted.org/packages/df/d3/5cc916d3be83ab1f776de3a4d019e2cc2dbd2c3ee73d0f7dc44a6d177e8f/myRIO_library-1.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c9ef788bb10e0f290244d37fb67d817e3767bb9b07ed529c31c328ddd026aed0",
"md5": "bcf1b331e3f6bae96b1e7a51eb9b090b",
"sha256": "1426052123b6f39a0e02e466b4d552381e8a277545082ac036ba4910af943914"
},
"downloads": -1,
"filename": "myrio_library-1.3.3.tar.gz",
"has_sig": false,
"md5_digest": "bcf1b331e3f6bae96b1e7a51eb9b090b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 972067,
"upload_time": "2024-04-15T08:36:37",
"upload_time_iso_8601": "2024-04-15T08:36:37.721533Z",
"url": "https://files.pythonhosted.org/packages/c9/ef/788bb10e0f290244d37fb67d817e3767bb9b07ed529c31c328ddd026aed0/myrio_library-1.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-15 08:36:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AitzolEzeizaUPVEHU",
"github_project": "myRIO_library",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "myrio-library"
}
JSON
