# Welcome to LiteX-CNC!
This project aims to make a generic CNC firmware and driver for FPGA cards which are supported by LiteX. Configuration of the board and driver is done using json-files. The supported boards are the Colorlight boards 5A-75B and 5A-75E, as these are fully supported with the open source toolchain.
> **RV901T** <br>
> Although the RV901T is also supported by Litex, the firmware cannot be automatically build with LitexCNC, as it requires the Xilinx-software to compile the Verilog to a bit-stream. LitexCNC can be used to create the Verilog and the driver will work when the bit-stream is loaded on the board. However, there is a gap in the toolchain not covered. There are known issues with the compantibility of Litex with Xilinx.
The idea of this project was conceived by ColorCNC by *romanetz* on the official LinuxCNC and the difficulty to obtain a MESA card.
## Acknowledgements
This project would not be possible without:
- ColorCNC by *romanetz* [link](https://forum.linuxcnc.org/27-driver-boards/44422-colorcnc?start=0);
- HostMot2 (MESA card driver) as the structure of the driver has been adopted.
## Quick start
LitexCNC can be installed using pip:
```shell
pip install litexcnc[cli]
```
> **NOTE: Suffix `[cli]` required!** <br>
> The suffix `[cli]` is required to install the command-line interface. Without this suffix the scripts referenced below will not work.
After installation of LitexCNC the following scripts are available to the user:
```shell
litexcnc install_driver
litexcnc install_litex
litexcnc install_toolchain
litexcnc build_driver
```
For a full overview on how to use the commands, please refer to the `documentation <https://litex-cnc.readthedocs.io/en/stable/>`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/Peter-van-Tol/LiteX-CNC",
"name": "litexcnc",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "FPGA,CNC,CNC-controller,CNC-machine,linuxcnc,linuxcnc-FPGA,litex",
"author": "Peter van Tol",
"author_email": "petertgvantol@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f6/de/c1b8b46957c1fa6731d06a3d5bd157de26d8d021f8dce59da9457ce0e28f/litexcnc-1.2.4.tar.gz",
"platform": null,
"description": "# Welcome to LiteX-CNC!\n\nThis project aims to make a generic CNC firmware and driver for FPGA cards which are supported by LiteX. Configuration of the board and driver is done using json-files. The supported boards are the Colorlight boards 5A-75B and 5A-75E, as these are fully supported with the open source toolchain.\n\n> **RV901T** <br>\n> Although the RV901T is also supported by Litex, the firmware cannot be automatically build with LitexCNC, as it requires the Xilinx-software to compile the Verilog to a bit-stream. LitexCNC can be used to create the Verilog and the driver will work when the bit-stream is loaded on the board. However, there is a gap in the toolchain not covered. There are known issues with the compantibility of Litex with Xilinx.\n\nThe idea of this project was conceived by ColorCNC by *romanetz* on the official LinuxCNC and the difficulty to obtain a MESA card.\n\n## Acknowledgements\nThis project would not be possible without:\n- ColorCNC by *romanetz* [link](https://forum.linuxcnc.org/27-driver-boards/44422-colorcnc?start=0);\n- HostMot2 (MESA card driver) as the structure of the driver has been adopted.\n\n## Quick start\nLitexCNC can be installed using pip:\n```shell\npip install litexcnc[cli]\n```\n\n> **NOTE: Suffix `[cli]` required!** <br>\n> The suffix `[cli]` is required to install the command-line interface. Without this suffix the scripts referenced below will not work.\n\nAfter installation of LitexCNC the following scripts are available to the user:\n```shell\nlitexcnc install_driver\nlitexcnc install_litex\nlitexcnc install_toolchain\nlitexcnc build_driver\n```\n\nFor a full overview on how to use the commands, please refer to the `documentation <https://litex-cnc.readthedocs.io/en/stable/>`_.\n\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Generic CNC firmware and driver for FPGA cards which are supported by LiteX",
"version": "1.2.4",
"project_urls": {
"Documentation": "https://litex-cnc.readthedocs.io/en/latest/",
"Homepage": "https://github.com/Peter-van-Tol/LiteX-CNC",
"Repository": "https://github.com/Peter-van-Tol/LiteX-CNC"
},
"split_keywords": [
"fpga",
"cnc",
"cnc-controller",
"cnc-machine",
"linuxcnc",
"linuxcnc-fpga",
"litex"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b00207d187a12a41ddae81928bafc8df0de19171c08e0d5d6a1b2dc7da9da220",
"md5": "1aa1d00703d76ba0b66b9060ae300f95",
"sha256": "64c239c31ca8a138290326c1cf9878f97438fa5aa7b753d5e81f9fef4b4dc511"
},
"downloads": -1,
"filename": "litexcnc-1.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1aa1d00703d76ba0b66b9060ae300f95",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 144279,
"upload_time": "2024-02-18T21:30:17",
"upload_time_iso_8601": "2024-02-18T21:30:17.478891Z",
"url": "https://files.pythonhosted.org/packages/b0/02/07d187a12a41ddae81928bafc8df0de19171c08e0d5d6a1b2dc7da9da220/litexcnc-1.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f6dec1b8b46957c1fa6731d06a3d5bd157de26d8d021f8dce59da9457ce0e28f",
"md5": "b7f443f0a43830f9855ef558fefffbd4",
"sha256": "706f74ffc2a65ebbfa010b7a2407e122e8025e8c789d9b3e9a4c5eae68869d12"
},
"downloads": -1,
"filename": "litexcnc-1.2.4.tar.gz",
"has_sig": false,
"md5_digest": "b7f443f0a43830f9855ef558fefffbd4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 95543,
"upload_time": "2024-02-18T21:30:19",
"upload_time_iso_8601": "2024-02-18T21:30:19.156307Z",
"url": "https://files.pythonhosted.org/packages/f6/de/c1b8b46957c1fa6731d06a3d5bd157de26d8d021f8dce59da9457ce0e28f/litexcnc-1.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-18 21:30:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Peter-van-Tol",
"github_project": "LiteX-CNC",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "litexcnc"
}
JSON
